GET
/
v1
/
customers
curl --request GET \
  --url https://api.malga.io/v1/customers \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "meta": {
    "itemCount": 10,
    "totalItems": 20,
    "itemsPerPage": 10,
    "totalPages": 5,
    "currentPage": 2
  },
  "items": [
    {
      "id": "82aba896-9e37-45b6-aa90-d510c9050596",
      "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
      "createdAt": "2012-06-30 23:59:59 +0000",
      "name": "Customer test",
      "email": "jose2@gmail.com",
      "phoneNumber": "21 98889999099",
      "document": {
        "number": "97055503019",
        "type": "cpf",
        "country": "BR"
      },
      "address": {
        "country": "BR",
        "state": "Rio de Janeiro",
        "city": "Rio de Janeiro",
        "district": "Leblon",
        "zipCode": "25650011",
        "street": "Av Geraldo Cardoso",
        "streetNumber": "205",
        "complement": "Apto 203"
      }
    }
  ]
}

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

200
application/json
Success
​
meta
object
​
items
any

Was this page helpful?

Recupera sessão com os dados das configurações da empresaCriação de novo customer para cobrança