BizKitHub
DocsAPI ReferenceCustomer/api/v1/customer/list
getCustomerPublic API v1

/api/v1/customer/list

Returns a paginated list of all customers in the organisation.

customergetApiV1CustomerList

Parameters

3 query

Query parameters

· 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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
limitnumberRequired

Number of items per page.

Default: 100
Example100
pagenumberRequired

Page number.

Default: 1
Example1

Response schema

1 status code documented

200Success
itemCountnumberRequired
Example10
itemsobject[]Required
Each array item:
cuRefNostringRequired

cuRefNo = customer reference number.

Length: 16–16
Example1cGIHvFoQDGLAbcA
emailstringRequired

Contact email address.

The system validates the input as a standard email address and automatically applies normalization and canonicalization.

All API responses return the normalized form, and each email address is unique per organisation within the system.

Phone-only contacts: Since 2026-06-10 a contact may exist without an e-mail when it was registered only by phone (e.g. imports of phone-only records). Responses that expose such contacts use API_EMAIL_NULLABLE instead, where this field can be null. Endpoints that accept e-mail as input still require a valid value here — phone-only creation goes through admin-only import / BFF flows.

Examplejan@barasek.com
localestringRequired

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

  • en-GB vs. en-US (British vs. American spelling)
  • pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
  • zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
  • sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendict → en-GB → en (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 2–35
Examplescsenen-GBpt-BRzh-Hans
firstNamestringOptional
ExampleJan
lastNamestringOptional
ExampleBarášek
registeredbooleanRequired
Exampletrue
premiumbooleanRequired
Exampletrue
creditnumberRequired
Example123
referralCuRefNostringOptional

Parent referral customer relation.

Example5CmsaVNgAQqRqoen
referredCustomerCountnumberRequired

Number of customer who referred this customer.

Example2
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastActivityDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "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"
    }
  ]
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key