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

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

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

identityIdstringrequired

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

querystring

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

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/customer/matched-customer-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&query=example_query", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

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

get

Example Response

200Success

{
  "success": true
}

cURL

Command line example

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"

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key

Back to API Documentation API Reference