/api/v1/customer/list

API endpoint documentation

Endpoint Info

Base URLapi.bizkithub.com

AuthBearer Token

Methods1

Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

3 query parameters

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

Default: 100

pagenumberrequired

Default: 1

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/customer/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&limit=100&page=1", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);

get

Example Response

200Success

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

cURL

Command line example

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

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key

Back to API Documentation API Reference