Liste todos os seus clientes.

Método

import { Malga } from 'malga'

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

await malga.customers.list()
{
  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
  }
}

Parâmetros

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

page
number

Número da página que deverá ser listada

limit
number

Limite de itens por página

sort
string

Ordenação da listagem, padrão é ASC



Os valores suportados são: ASC ou DESC

documentType
string

Tipo do documento

documentNumber
string

Número do documento