Skip to main content
GET
/
api
/
customers
Listar Clientes
curl --request GET \
  --url https://api.example.com/api/customers

​
Listar Clientes

Retorna uma lista paginada de todos os clientes do projeto.

​
Autenticação

Authorization: Bearer sk_test_xxx

​
Query Parameters

​
page
integer
Número da página. Default: 1.
​
limit
integer
Itens por página (máximo 100). Default: 10.
​
dateFrom
string
Filtrar clientes criados a partir desta data (ISO 8601).
​
dateTo
string
Filtrar clientes criados até esta data (ISO 8601).

​
Response (200)

{
  "success": true,
  "data": [
    {
      "id": "cly1234567890",
      "name": "João Silva",
      "document": "12345678900",
      "email": "[email protected]",
      "phone": "11999999999",
      "street": "Rua Exemplo",
      "streetNumber": "123",
      "neighborhood": "Centro",
      "complement": null,
      "zipCode": "01310100",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "isBlocked": false,
      "createdAt": "2026-01-16T10:00:00.000Z",
      "updatedAt": "2026-01-16T10:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}

​
Erros

HTTPCódigoDescrição
401ERR_AUTH_009Token inválido

Precisa de ajuda?

Nossa equipe está disponível para auxiliar no processo de desenvolvimento. Entre em contato pelo e-mail [email protected].