Find by ID

GET

/api/user/customers/{id}

Este endpoint permite consultar os detalhes de um cliente específico, utilizando seu identificador único (id).

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/customers/{id}

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 Caminho (Path Parameters)

Campo	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador único do cliente

Request

Path 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/' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
    "message": "Cliente encontrado com sucesso.",
    "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"
    },
    "status": 200,
    "error": null
}

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

Find all

Find

Find by ID

✅ Requisitos da Requisição#

🧠 Header da requisição#

📥 Parâmetros de Caminho (Path Parameters)#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

📥 Parâmetros de Caminho (Path Parameters)