# Listar todos os clientes

Liste todos os clientes de Débito Direto associados à sua conta.

Endpoint: GET /customers/
Version: 1.0.0
Security: ApiKeyAuth, ApiKeySecret

## Query parameters:

  - `page` (integer)
    Um número de página dentro do conjunto de resultados paginados.
    Example: 1

  - `limit` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 20 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 100. Se você inserir um valor maior que 100, nossa API usará o valor máximo (100) por padrão.
    Example: 15

  - `search` (string)
    Retorne resultados que correspondam ao email, firstname, lastname ou documentNumber que você pesquisou.

Nota:

Este filtro suporta consultas de pesquisa completas e parciais.

Por exemplo, pesquisar por car pode corresponder aos seguintes valores:

  - carlos.vives@musicamexico.mx (email)
  - Carlos (firstname)
  - Cartregena (lastname)
  - 789-CAR-789456789 (documentNumber)
    Example: "trai"

## Response 200 fields (application/json):

  - `items` (array)
    Um array de objetos de clientes.
    - `id` (string)
      O identificador único criado pela Belvo usado para referenciar o cliente.
      Example: "3118128a-6792-4b06-bd61-4acf6f6ad6b5"
    - `createdDate` (string,null)
      O timestamp ISO-8601 quando o cliente foi criado no banco de dados da Belvo.
      Example: "2022-02-09T08:45:50.406032Z"
    - `lastUpdatedDate` (string,null)
      O carimbo de data e hora ISO-8601 quando as informações sobre o cliente foram atualizadas pela última vez.
      Example: "2022-02-09T08:45:50.406032Z"
    - `firstname` (string)
      O primeiro nome do cliente.
      Example: "Carlos"
    - `lastname` (string)
      O sobrenome do cliente.
      Example: "Vives"
    - `email` (string)
      O email do cliente.
      Example: "carlos-vives@musica.mx"
    - `phone` (string)
      O número de telefone do cliente (incluindo o código do país).
      Example: "+523001234567"
    - `country` (string)
      O código de três letras do país do cliente conforme a norma ISO 3166-1 alpha-3.
      Example: "mex"
    - `documentType` (string)
      O tipo de documento do indivíduo.

Para 🇲🇽 México, pode ser um dos seguintes:
  - mx_rfc: Número de Identificação Fiscal (Registro Federal de Contribuyentes)
  - mx_curp: Código Único de Registro de População (Clave Única de Registro de Población)
      Enum: "mx_rfc", "mx_curp"
    - `documentNumber` (string)
      O número do documento do cliente.
      Example: "123456789"

  - `metadata` (object)
    Metadados adicionais sobre o conjunto de resultados paginados.

  - `metadata.totalItems` (integer)
    O número total de itens no conjunto de resultados paginados.
    Example: 100

  - `metadata.itemCount` (integer)
    O número de itens na página atual.
    Example: 10

  - `metadata.itemsPerPage` (integer)
    O número de itens solicitados por página.
    Example: 10

  - `metadata.totalPages` (integer)
    O número total de páginas no conjunto de resultados paginados.
    Example: 10

  - `metadata.currentPage` (integer)
    O número da página atual.
    Example: 1

  - `links` (object)
    Links para navegar no conjunto de resultados paginados.

  - `links.first` (string)
    A URL para a primeira página do conjunto de resultados paginados.
    Example: "/{resource}?limit=20"

  - `links.last` (string)
    A URL para a última página do conjunto de resultados paginados.
    Example: "/{resource}?page=4&limit=20"

  - `links.next` (string)
    A URL para a próxima página do conjunto de resultados paginados.
    Example: "/{resource}?page=3&limit=20"

  - `links.previous` (string)
    A URL para a página anterior do conjunto de resultados paginados.
    Example: "/{resource}?page=2&limit=20"

## Response 400 fields (application/json):

  - `statusCode` (integer)
    O código de status HTTP para este erro.
    Example: 400

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Bad Request"

  - `message` (any)
    Uma breve descrição do erro, indicando o que está errado com a solicitação.
> Nota: Retornamos uma string ou um array de strings, dependendo do(s) erro(s) de validação.

A descrição pode ser (entre outras):

  - id must be a UUID
  - Not enough balance
  - amount is not a valid decimal number.
  - currency must be one of the following values: cop, mxn, usd
  - reference must be a string
  - Customer not found for merchant
  - documentType is a required field
    Example: "id must be a UUID"

## Response 401 fields (application/json):

  - `statusCode` (integer)
    O código de status HTTP para este erro.
    Example: 401

  - `error` (string)
    A descrição do código de status HTTP para este erro.
    Example: "Unauthorized"

  - `message` (string)
    Uma breve descrição do erro, indicando o que está errado com a solicitação. No caso de um erro 401 Unauthorized, a mensagem é:

  - Unauthorized credentials
    Example: "Unauthorized credentials"