Parameters
1 query
Query parameters
· 1cuRefNostringRequiredcuRefNo = customer reference number.
Length: 16–16
Example
1cGIHvFoQDGLAbcA/api/v1/referral/referred-customers
Returns a list of customers referred by the given customer (identified by cuRefNo).
referralgetApiV1ReferralReferred-customers
Response schema
1 status code documented
200Success
itemsobject[]RequiredEach array item:
cuRefNostringRequiredcuRefNo = customer reference number.
Length: 16–16
Example
1cGIHvFoQDGLAbcAemailstringRequiredContact 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.
Example
jan@barasek.comfirstNamestringOptionalExample
JanlastNamestringOptionalExample
BarášekinsertedDateDate | string | string | numberRequiredOne of 4:
Variant 1
Date
Example
2025-01-10T16:19:40.150ZVariant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastActivityDateDate | string | string | numberRequiredOne of 4:
Variant 1
Date
Example
2025-01-10T16:19:40.150ZVariant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Response example
application/json{
"items": [
{
"cuRefNo": "1cGIHvFoQDGLAbcA",
"email": "jan@barasek.com",
"firstName": "Jan",
"lastName": "Barášek",
"insertedDate": "2025-01-10T16:19:40.150Z",
"lastActivityDate": "2025-01-10T16:19:40.150Z"
}
]
}Request example
GET /api/v1/referral/referred-customers
curl -X GET "https://api.bizkithub.com/api/v1/referral/referred-customers?cuRefNo=1cGIHvFoQDGLAbcA" \
-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.