Find all

GET

/api/user/customers

Este endpoint permite listar todos os clientes vinculados ao recebedor autenticado.
É possível utilizar paginação para controlar a quantidade de dados retornados.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/customers

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

🔎 Parâmetros de Consulta (Query Parameters)

Campo	Tipo	Obrigatório	Descrição
`page`	string	Não	Página atual da listagem. Ex: `1`
`limit`	string	Não	Quantidade de clientes por página. Ex: `10`

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/customers?page&limit' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
    "status": 200,
    "message": "Clientes listados com sucesso",
    "data": {
        "data": [
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
                "externalRef": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
                "name": "JOHN DOE",
                "email": "johndoe@gmail.com",
                "phone": "1234567890",
                "birthdate": null,
                "createdAt": "2025-04-17T17:57:19.500Z",
                "addressId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX"
            },
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
                "externalRef": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX",
                "name": "JOHN DOE",
                "email": "johndoe@gmail.com",
                "phone": "1234567890",
                "birthdate": null,
                "createdAt": "2025-04-17T17:56:51.034Z",
                "addressId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX"
            }
            
        ],
        "pages": 22,
        "page": 1,
        "limit": 10,
        "total": 211
    },
    "error": null
}

Modified at 2025-07-23 19:02:40

Find by ID

Find all

✅ Requisitos da Requisição#

🧠 Header da requisição#

🔎 Parâmetros de Consulta (Query Parameters)#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

🔎 Parâmetros de Consulta (Query Parameters)