/api/v1/customer/list

Returns a paginated list of all customers in the organisation.

customergetApiV1CustomerList

Parameters

3 query

3 total

Query · 3

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

limitnumberRequired

Number of items per page.

Default: 100

pagenumberRequired

Page number.

Default: 1

Request

GET /api/v1/customer/list

get

curl -X GET "https://api.bizkithub.com/api/v1/customer/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&limit=100&page=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "itemCount": 10,
  "items": [
    {
      "cuRefNo": "1cGIHvFoQDGLAbcA",
      "email": "jan@barasek.com",
      "locale": "cs",
      "firstName": "Jan",
      "lastName": "Barášek",
      "registered": true,
      "premium": true,
      "credit": 123,
      "referralCuRefNo": "5CmsaVNgAQqRqoen",
      "referredCustomerCount": 2,
      "insertedDate": "2025-01-10T16:19:40.150Z",
      "updatedDate": "2025-01-10T16:19:40.150Z",
      "lastActivityDate": "2025-01-10T16:19:40.150Z"
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key