Partner
A query partner retorna informações de um único parceiro, buscando-o através de seu token de acesso.
Requisição
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
partnerAccessToken | String | Sim | Token de acesso para identificar o parceiro. |
Campos
Retorna um objeto do tipo Partner
, contendo os dados públicos do parceiro. Se o token fornecido for inválido ou se não for fornecido nenhum token, o campo partner
será null
.
Campo | Tipo | Descrição |
---|---|---|
alias | String | O apelido do parceiro. |
endDate | DateTime! | O parceiro é válido até esta data. |
fullUrlLogo | String | A URL completa do logo do parceiro. |
id | ID | O identificador único do nó. |
logoUri | String | A URL do logo do parceiro. |
name | String | O nome do parceiro.. |
origin | String | A origem do parceiro. |
partnerAccessToken | String | O token de acesso do parceiro. |
partnerId | Long! | O identificador único do parceiro. |
portfolioId | Int! | O identificador do portfólio atribuído a este parceiro. |
priceTableId | Int! | O identificador da tabela de preços atribuído a este parceiro |
startDate | DateTime! | O parceiro é válido a partir desta data. |
type | String | O tipo do escopo em que o parceiro é usado. |
Exemplo
Neste exemplo, são solicitadas informações básicas de um parceiro específico.
query {
partner(partnerAccessToken: "exemplo_token_de_acesso") {
id
name
alias
endDate
}
}
{
"data": {
"partner": {
"id": "UGFydG5lcjo2MDAw",
"name": "Parceiro de Exemplo Ltda.",
"alias": "parceiro-exemplo",
"endDate": "2025-12-31T23:59:59Z"
}
}
}
Updated 9 days ago