Estamos trabalhando nessa nova versão da documentação.
Para visitar a versão antiga: API Pipeimob - Postman.

Consultar Agências

POST

/v1/agencias

Retorna uma lista de agências da franqueadora.

Paginação (query): 'limit' (padrão 50, máx 50).
Paginação (query): 'page' (padrão 1).
Metadados de paginação no corpo de resposta (campo data.meta.pagination):

total: total de itens completos antes do corte.

count: quantidade de itens devolvidos nesta resposta.

per_page: itens por página.

current_page: página atual (1-based).

total_pages: ceil(total/per_page).

Mapeamento de erros (formato {ok,false,message,data=null}):

401: credenciais ausentes/invalidas.

403: escopo insuficiente.

400: não franqueadora.

405: método não permitido (esta rota aceita POST).

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200Correto

application/json

Successful Response

Body

🟠422Entidade não processável

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/agencias?limit&page' \
--header 'authorization;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "success": true,
    "message": "",
    "data": {
        "tipoUser": "agencia",
        "agencias_count": 0,
        "agencias": [],
        "meta": {}
    }
}

Modificado em 2025-10-20 11:59:10