tipoquery · stringOptionalFilter by contractor type. When omitted, returns both types.
Constraints
{
"type": "string",
"enum": [
"motorista",
"transportadora"
]
}← HomeFleetPay / API
List contracted drivers and their status
Parameters, data structure and responses from the versioned contract.
GET
/agregadosTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Lists those working for your company in FleetPay and answers the key question: can this contracted driver or carrier receive funds yet?
This is the other side of the invitation. POST /convites/transportadoras starts the conversation; this endpoint reports its progress without requiring you to ask support.
Who appears in the list is determined by the relationship, not by who created the registration:
tipo | Who it is |
|---|---|
motorista | a driver contracted by your company (or a branch in your group) |
transportadora | a carrier you contract or have invited |
A carrier you invited appears here before completing registration, with cadastro: "convidado" — exactly when you need to track progress. Once registration is complete, the same row changes to cadastro: "cadastrado" and displays the account.
The decisive field is conta.habilitado_a_receber. It already combines account status, biometric verification and blocking; situacao, biometria and pendencia let you explain what is missing to your operator, rather than recalculate the rule.
This query does not return an account number or Pix key. It tells you whether the contracted driver or carrier can receive funds, not where to send them — FleetPay continues to handle payment.
Authentication
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.
Parameters
paginaquery · integerOptionalConstraints
{
"type": "integer",
"minimum": 1,
"default": 1
}por_paginaquery · integerOptionalMaximum of 200 per page.
Constraints
{
"type": "integer",
"minimum": 1,
"maximum": 200,
"default": 50
}Responses
200 HTTP Response
List of your company's contractors
application/json
401 HTTP Response
Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.
429 HTTP Response
Request limit exceeded (limite_requisicoes). Wait for the interval specified in the Retry-After header before retrying. This may be a limit forwarded from the provider or FleetPay's own anti-abuse limit, counted per authenticated company and route group, with a short window for bursts and a long window for slower automated traffic. Limits are intentionally generous: genuine integrations, including large batches processed at once, should remain well below them. If yours reaches a limit, contact FleetPay.
Complete Operation Definition
{
"tags": [
"Agregados"
],
"summary": "Listar os seus agregados e a situação de cada um",
"operationId": "listarAgregados",
"description": "Lista quem trabalha para a sua empresa na FleetPay e responde a pergunta que importa:\n**este agregado já pode receber?**\n\nÉ o outro lado do convite. `POST /convites/transportadoras` inicia a conversa; este\nendpoint conta onde ela chegou, sem você precisar perguntar ao suporte.\n\n**Quem entra na lista** — o vínculo, não o cadastro que você fez:\n\n| `tipo` | Quem é |\n|---|---|\n| `motorista` | motorista agregado da sua empresa (ou de uma filial do seu grupo) |\n| `transportadora` | transportadora que você contrata, **ou** que você convidou |\n\nUma transportadora que você convidou aparece aqui **antes** de concluir o cadastro, com\n`cadastro: \"convidado\"` — é exatamente o intervalo em que você quer saber se ela andou.\nQuando ela conclui, a mesma linha passa a `cadastro: \"cadastrado\"` e a mostrar a conta.\n\n**O campo que decide é `conta.habilitado_a_receber`.** Ele já combina situação da conta,\nbiometria e bloqueio; `situacao`, `biometria` e `pendencia` existem para você explicar ao\nseu operador o que falta, não para você recalcular a regra.\n\n> Esta consulta **não** devolve número de conta nem chave PIX. Ela responde *se* o\n> agregado pode receber, não por onde — o pagamento continua sendo conduzido pela\n> FleetPay.\n",
"parameters": [
{
"name": "tipo",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"motorista",
"transportadora"
]
},
"description": "Filtra por natureza do agregado. Ausente, traz os dois."
},
{
"name": "pagina",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
}
},
{
"name": "por_pagina",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"default": 50
},
"description": "Máximo de 200 por página."
}
],
"responses": {
"200": {
"description": "Lista dos agregados da sua empresa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaAgregados"
}
}
}
},
"400": {
"$ref": "#/components/responses/Erro400"
},
"401": {
"$ref": "#/components/responses/Erro401"
},
"403": {
"$ref": "#/components/responses/Erro403"
},
"429": {
"$ref": "#/components/responses/Erro429"
},
"500": {
"$ref": "#/components/responses/Erro500"
}
},
"method": "GET",
"path": "/agregados"
}