Get Clients
Get a list of destination clients associated with your platform client and secret. This request will return a list of destination client id
s that you can use to make requests to the Axle API on behalf of your destination clients.
See the Axle for Platforms guide for more information on how to use this endpoint and the destination client id
.
curl --request GET \
--url https://api.axle.insure/platform/clients \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
{
"data": [
"<string>"
],
"success": true
}
Headers
Your client ID. This will be shared with you during onboarding.
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!
Query Parameters
Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.
Response
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.
Indicates whether the operation was performed successfully.
curl --request GET \
--url https://api.axle.insure/platform/clients \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
{
"data": [
"<string>"
],
"success": true
}