---
title: "Listar clientes"
method: GET
path: "/v1/customers"
tags: ["Clientes"]
---

# Listar clientes

`GET /v1/customers`

Retorna uma lista paginada de clientes com suporte a filtros.

## Query parameters

- `page` integer
- `pageSize` integer
- `status` 'Active' | 'Inactive'
- `documentType` 'CPF' | 'CNPJ'
- `search` string
- `externalId` string

## Response `200`

Lista de clientes

- ListCustomersResponse
  - `data` PaginatedCustomers, nullable
    - `items` CustomerData[]
      - `id` string, uuid — ID unico do cliente
      - `externalId` string, nullable — ID externo informado
      - `name` string — Nome do cliente
      - `email` string — E-mail do cliente
      - `document` string, nullable — CPF/CNPJ formatado
      - `documentType` 'CPF' | 'CNPJ', nullable — Tipo do documento
      - `phone` string, nullable — Telefone com codigo do pais, salvo apenas com digitos
      - `status` 'Active' | 'Inactive' — Status do cliente
      - `metadata` string, nullable — Metadados
      - `address` CustomerAddress, nullable
        - `street` string, nullable
        - `number` string, nullable
        - `complement` string, nullable
        - `neighborhood` string, nullable
        - `city` string, nullable
        - `state` string, nullable
        - `postalCode` string, nullable
        - `country` string, nullable
      - `createdAt` string, date-time — Data de criacao
    - `page` integer
    - `pageSize` integer
    - `totalItems` integer
    - `totalPages` integer
    - `hasNextPage` boolean
    - `hasPreviousPage` boolean
  - `message` string, nullable
  - `error` ApiErrorResponse, nullable
    - `message` string — Mensagem de erro
    - `code` string — Codigo do erro

## Other responses

- `401` — Nao autorizado

---

[API](https://skmtc.net/safefy-pay/apis/safefy-pix-gateway.md) · [All operations](https://skmtc.net/safefy-pay/apis/safefy-pix-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safefy-pay/safefy-pix-gateway/revisions/c4fd84385e23/schema)