v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB

Clientes

Listar clientes

Retorna uma lista paginada de clientes com suporte a filtros.

get/v1/customers

Query parameters

pageinteger

Example:1

Numero da pagina

pageSizeinteger

Example:20

Itens por pagina (max: 100)

status'Active' | 'Inactive'

Example:Active

Filtrar por status

documentType'CPF' | 'CNPJ'

Example:CPF

Filtrar por tipo de documento

searchstring

Example:joao

Buscar por nome, email ou documento

externalIdstring

Example:cliente_123

Filtrar por ID externo

Response

Lista de clientes

messagestring nullable

Example response

{
  "data": {
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "externalId": "cliente_123",
        "name": "Joao Silva",
        "email": "joao@email.com",
        "document": "123.456.789-00",
        "documentType": "CPF",
        "phone": "5511999998888",
        "status": "Active",
        "address": {
          "street": "Rua das Flores",
          "number": "123",
          "complement": "Apto 45",
          "neighborhood": "Centro",
          "city": "Sao Paulo",
          "state": "SP",
          "postalCode": "01234-567",
          "country": "BR"
        },
        "createdAt": "2025-01-15T15:00:00Z"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalItems": 50,
    "totalPages": 3,
    "hasNextPage": true
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}