> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Listar clientes > Lista os compradores da empresa autenticada, do cadastro mais recente para o mais antigo, com paginação e busca livre por nome, e-mail, telefone ou documento. Clientes excluídos não aparecem. Use para sincronizar a sua base de contatos com a da Ephra. ## OpenAPI ````yaml /openapi.yaml get /v1/customers openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/customers: get: tags: - Vendas summary: Listar clientes description: >- Lista os compradores da empresa autenticada, do cadastro mais recente para o mais antigo, com paginação e busca livre por nome, e-mail, telefone ou documento. Clientes excluídos não aparecem. Use para sincronizar a sua base de contatos com a da Ephra. operationId: listCustomers parameters: - schema: type: integer minimum: 1 default: 1 in: query name: page required: false description: Página desejada, começando em 1. - schema: type: integer minimum: 1 maximum: 100 default: 10 in: query name: pageSize required: false description: Quantidade de itens por página (máximo 100). - schema: type: string minLength: 1 in: query name: search required: false description: >- Busca livre por nome, e-mail, telefone ou documento. O documento casa só pelos dígitos. responses: '200': description: Página de clientes da empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: array items: type: object properties: id: type: string description: Identificador do cliente. name: type: string description: Nome completo do cliente. email: type: string nullable: true description: E-mail principal do cliente. phone: type: string nullable: true description: Telefone do cliente, com DDI e DDD. document: type: string description: CPF ou CNPJ, apenas dígitos. documentType: type: string description: >- Tipo do documento, deduzido do número: `CPF` ou `CNPJ`. instagram: type: string nullable: true description: Perfil do Instagram informado no checkout. birthDate: type: string format: date-time nullable: true description: Data de nascimento. mailMarketing: type: boolean description: >- `true` quando o cliente aceitou receber comunicação de marketing. taxFree: type: boolean description: >- `true` quando o cliente é isento de imposto na emissão de nota. tags: type: array items: type: string description: Etiquetas livres usadas para segmentar o cliente. notes: type: string nullable: true description: Anotações internas do vendedor sobre o cliente. address: type: object properties: street: type: string description: Logradouro. streetNumber: type: string description: Número. complement: type: string nullable: true description: Complemento, quando houver. neighborhood: type: string description: Bairro. city: type: string description: Município. state: type: string description: Sigla da unidade federativa, com duas letras. zipCode: type: string description: CEP, apenas dígitos. required: - street - streetNumber - complement - neighborhood - city - state - zipCode additionalProperties: false nullable: true description: Endereço de entrega do cliente. createdAt: type: string format: date-time description: Momento de criação do cadastro. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - name - email - phone - document - documentType - instagram - birthDate - mailMarketing - taxFree - tags - notes - address - createdAt - updatedAt additionalProperties: false pagination: type: object properties: page: type: integer description: Página devolvida. pageSize: type: integer description: Itens por página pedidos. total: type: integer description: Total de itens que satisfazem o filtro. totalPages: type: integer description: Total de páginas disponíveis. required: - page - pageSize - total - totalPages additionalProperties: false required: - success - data - pagination additionalProperties: false description: Página de clientes da empresa. example: success: true data: - id: cmtxc7d910004hlg1q8w2ker3 name: Mariana Ribeiro Alves email: mariana.alves@exemplo.com.br phone: '+5521998877665' document: '39053344705' documentType: CPF instagram: '@mariana.alves' birthDate: '1991-04-17T00:00:00.000Z' mailMarketing: true taxFree: false tags: - lancamento-setembro - cliente-recorrente notes: >- Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra. address: street: Rua Visconde de Pirajá streetNumber: '414' complement: sala 1108 neighborhood: Ipanema city: Rio de Janeiro state: RJ zipCode: '22410002' createdAt: '2026-08-14T11:20:33.000Z' updatedAt: '2026-09-09T16:41:02.000Z' pagination: page: 1 pageSize: 10 total: 1 totalPages: 1 '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````