> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Buscar um Cliente

> Retorna os dados de um cliente específico baseado em filtros.

Você pode usar essa rota para buscar um cliente por ID ou outros critérios.


Retorna os dados de um cliente pelo seu `id`.

<Card horizontal>
  Requer a permissão `CUSTOMER:READ`.
</Card>

Use para recuperar o `id` de um cliente antes de criar uma cobrança ou para verificar os dados cadastrados.


## OpenAPI

````yaml GET /customers/get
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /customers/get:
    get:
      summary: Buscar um cliente
      description: >
        Retorna os dados de um cliente específico baseado em filtros.


        Você pode usar essa rota para buscar um cliente por ID ou outros
        critérios.
      parameters:
        - name: id
          in: query
          description: Identificador único público do cliente
          required: false
          schema:
            type: string
            example: cust_aebxkhDZNaMmJeKsy0AHS0FQ
      responses:
        '200':
          description: Cliente encontrado com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Customer'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
        '404':
          description: Cliente não encontrado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro indicando que o cliente não foi
                      encontrado.
                    example: Cliente não encontrado.
      security:
        - bearerAuth: []
components:
  schemas:
    Customer:
      type: object
      description: Os dados do seu cliente.
      required:
        - id
        - devMode
        - name
        - cellphone
        - email
        - taxId
      additionalProperties: false
      properties:
        id:
          type: string
          description: Identificador único público do cliente
          example: cust_aebxkhDZNaMmJeKsy0AHS0FQ
        devMode:
          type: boolean
          description: Indica se o cliente foi criado em ambiente de testes.
          example: true
        name:
          type: string
          description: Nome completo do cliente
          example: Daniel Lima
        cellphone:
          type: string
          description: Celular do cliente
          example: (11) 4002-8922
        email:
          type: string
          description: E-mail do cliente
          example: daniel_lima@abacatepay.com
        taxId:
          type: string
          description: CPF ou CNPJ do cliente
          example: 123.456.789-01
        country:
          type: string
          description: País do cliente
          example: BR
        zipCode:
          type: string
          description: CEP do cliente
          example: 01310-100
        metadata:
          type: object
          description: Metadados adicionais do cliente
          additionalProperties: true
          example:
            source: landing-page
            campaign: black-friday-2025
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````