/api/v1/address/list

Returns all addresses associated with a specific contact/customer. Each address includes type (delivery/billing/contact), personal/company details, and geographic information. The default address for the contact is marked with defaultAddress: true.

AddressgetApiV1AddressList

Parameters

2 query

2 total

Query · 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

identityIdstringRequired

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

Request

GET /api/v1/address/list

get

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

Response

List of customer addresses.

{
  "items": [
    {}
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key