v1

latestOpenAPI 3.0.1Apache 2.02026-07-26401961.7 KB

Customers

Get a list of business customers

get/customers

Query parameters

beforestring

When paginating results, a pointer to an ID before which we want results

Example:<entity>_01HC3J1VVVM05YCTS61G7V3KC6

afterstring

When paginating results, a pointer to an ID after which we want results

Example:<entity>_01HC3J1VVVM05YCTS61G7V3KC6

page_sizeinteger

The maximum number of items to return per page, defaults to 20

Example:20

Response

Success

Example response

{
  "pagination": {
    "next": "<entity>_01HC3J1VVVM05YCTS61G7V3KC6",
    "previous": "<entity>_01HC3J1VVVM05YCTS61G7V3KC6",
    "page_size": 20
  },
  "data": [
    {
      "id": "customer_01HC3HTDAXQ50E07CWR2A2CFBD",
      "customer_name": "John Doe",
      "email": "john@doe.com",
      "customer_tin": "P012345678P",
      "taxpayer_type": "INDIVIDUAL"
    }
  ]
}