GET
/
v1
/
customers
Listagem de customers cadastrados
curl --request GET \
  --url https://api.malga.io/v1/customers \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "createdAt": "<string>",
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "document": {
        "type": "<string>",
        "number": "<string>",
        "country": "BR"
      },
      "address": {
        "street": "<string>",
        "streetNumber": "<string>",
        "complement": "<string>",
        "zipCode": "<string>",
        "country": "BR",
        "state": "<string>",
        "city": "<string>",
        "district": "<string>"
      }
    }
  ]
}

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Query Parameters

page
number

número da página

limit
number

quantidade de itens por página

sort
enum<string>

ordenação dos itens

Available options:
ASC,
DESC
id
string

identificador de um customer

document.type
string

tipo de documento

document.number
string

numero do documento

Response

Success

items
object[]