/api/v1/customer/matched-customer-list

Returns a list of customers matched (linked) to the customer identified by identityId.

customergetApiV1CustomerMatched-customer-list

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

identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

querystring

Optional search query to filter matched customers by name or email.

Request

GET /api/v1/customer/matched-customer-list

get

curl -X GET "https://api.bizkithub.com/api/v1/customer/matched-customer-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&query=example_query" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key