GET
/
platform
/
clients
curl --request GET \
  --url https://sandbox.axle.insure/platform/clients \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <api-key>'
{
  "success": true,
  "data": [
    "<string>"
  ]
}

Authorizations

x-client-secret
string
headerrequired

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.

Headers

x-client-id
string
required

Your client ID. This will be shared with you during onboarding.

Query Parameters

expand
boolean

Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.

Response

200 - application/json
success
boolean

Indicates whether the operation was performed successfully.

data
string[]

A list of identifiers for the destination clients associated with your credential, or if expand=true, a list of the destination client id and entity fields.