Listar os seus agregados e a situação de cada um

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/agregados

listarAgregadosBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Lista quem trabalha para a sua empresa na FleetPay e responde a pergunta que importa: este agregado já pode receber?

É o outro lado do convite. POST /convites/transportadoras inicia a conversa; este endpoint conta onde ela chegou, sem você precisar perguntar ao suporte.

Quem entra na lista — o vínculo, não o cadastro que você fez:

`tipo`	Quem é
`motorista`	motorista agregado da sua empresa (ou de uma filial do seu grupo)
`transportadora`	transportadora que você contrata, ou que você convidou

Uma transportadora que você convidou aparece aqui antes de concluir o cadastro, com cadastro: "convidado" — é exatamente o intervalo em que você quer saber se ela andou. Quando ela conclui, a mesma linha passa a cadastro: "cadastrado" e a mostrar a conta.

O campo que decide é conta.habilitado_a_receber. Ele já combina situação da conta, biometria e bloqueio; situacao, biometria e pendencia existem para você explicar ao seu operador o que falta, não para você recalcular a regra.

Esta consulta não devolve número de conta nem chave PIX. Ela responde se o agregado pode receber, não por onde — o pagamento continua sendo conduzido pela FleetPay.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

tipoquery · stringOpcional

Filtra por natureza do agregado. Ausente, traz os dois.

Restrições

{
  "type": "string",
  "enum": [
    "motorista",
    "transportadora"
  ]
}

paginaquery · integerOpcional

Restrições

{
  "type": "integer",
  "minimum": 1,
  "default": 1
}

por_paginaquery · integerOpcional

Máximo de 200 por página.

Restrições

{
  "type": "integer",
  "minimum": 1,
  "maximum": 200,
  "default": 50
}

Respostas

200 Resposta HTTP

Lista dos agregados da sua empresa

`application/json`

RespostaAgregados ↗

dataarrayObrigatório

Agregado ↗

metaobjectObrigatório

PaginacaoAgregados ↗

ambienteobjectObrigatório

Ambiente ↗

400 Resposta HTTP

Requisição inválida

`application/json`

Erro ↗

errorobjectOpcional

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "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"
}