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

# Listar clientes

> API SDK Documentação - Customers

Liste todos os seus clientes.

### Método

<Tabs>
  <Tab title="Node.js">
    ```typescript theme={null}
    import { Malga } from 'malga'

    const malga = new Malga({
      apiKey: '17a64c8f-a387-4682-bdd8-d280493715e0',
      clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
    })

    await malga.customers.list()
    ```
  </Tab>
</Tabs>

<Tabs>
  <Tab title="Response">
    ```typescript theme={null}
    {
      items: [
        {
          id: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
          name: 'João da Silva',
          email: 'joao.silva@test.com',
          clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
          phoneNumber: '99999999999',
          createdAt: '2023-12-31T19:36:30.741Z',
          document: {
            number: '99999999999',
            type: 'cpf',
            country: 'BR'
          },
          address: {
            city: 'Rio de Janeiro',
            complement: 'Sala 214',
            country: 'BR',
            district: 'São Conrado',
            state: 'RJ',
            street: 'Estrada da Gávea',
            streetNumber: '696',
            zipCode: '22610002'
          }
        }
      ],
      meta: {
        totalItems: 1
        itemCount: 1
        itemsPerPage: 15
        totalPages: 1
        currentPage: 1
      }
    }
    ```
  </Tab>
</Tabs>

### Parâmetros

Lista de todos os parâmetros suportados pelo método.

<ParamField path="page" type="number">
  Número da página que deverá ser listada
</ParamField>

<ParamField path="limit" type="number">
  Limite de itens por página
</ParamField>

<ParamField path="sort" type="string">
  Ordenação da listagem, padrão é <code>ASC</code>

  <br />

  <br />

  Os valores suportados são: <code>ASC</code> ou <code>DESC</code>
</ParamField>

<ParamField path="documentType" type="string">
  Tipo do documento
</ParamField>

<ParamField path="documentNumber" type="string">
  Número do documento
</ParamField>