Skip to main content
GET
/
customers
List Customers
curl --request GET \
  --url https://api.mijnklantportaal.nl/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "data": [
    {
      "id": "cst_abc12345def678",
      "companyName": "Test Company BV",
      "address": "Teststreet 123",
      "zipCode": "1234AB",
      "city": "Amsterdam",
      "primaryEmail": "[email protected]",
      "phone": "+312012345678",
      "integration": "acumulus",
      "integrationId": "123456789",
      "customerGroups": [
        "cug_123abc567"
      ],
      "createdAt": "2024-04-28T21:00:00+02:00"
    }
  ],
  "first_page_url": "https://api.mijnklantportaal.nl/v1/customers?page=1",
  "from": 1,
  "next_page_url": "https://api.mijnklantportaal.nl/v1/customers?page=2,",
  "path": "https://api.mijnklantportaal.nl/v1/customers",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Paginated response with customers

​
current_page
integer

Current page of the response

Example:

1

​
data
object[]

Array of Customer objects

​
first_page_url
string

Endpoint to go to the first page of objects

Example:

"https://api.mijnklantportaal.nl/v1/customers?page=1"

​
from
integer

Offset of the current page

Example:

1

​
next_page_url
string | null

Endpoint to get the next batch of objects, if available

Example:

"https://api.mijnklantportaal.nl/v1/customers?page=2,"

​
path
string

Current used endpoint

Example:

"https://api.mijnklantportaal.nl/v1/customers"

​
per_page
integer

Amount of object returned per page. Default is 15 objects

Example:

15

​
prev_page_url
string | null

Endpoint to get the previous batch of object, if available

Example:

null

​
to
integer

Next offset of objects

Example:

15