/api/v1/customer/hierarchy

Returns the superior (at most one), subordinates (direct children), and colleagues (customers sharing the same non-null superior) for the given customer.

customergetApiV1CustomerHierarchy

Parameters

2 query

Query parameters

· 2

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

cuRefNostringRequired

cuRefNo = customer reference number.

Length: 16–16

Example1cGIHvFoQDGLAbcA

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

GET /api/v1/customer/hierarchy

get

curl -X GET "https://api.bizkithub.com/api/v1/customer/hierarchy?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&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.

Get API Key