Carriers
Get Carrier
Carriers
Get Carrier
The Get Carrier method returns a Carrier object that include additional details about an Axle-supported insurance carrier.
GET
/
carriers
/
{id}
Header
Path
curl --request GET \
--url https://api.axle.insure/carriers/{id} \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'{
"data": {
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"country": "USA",
"postalCode": "30315",
"state": "Georgia"
},
"domain": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"modifiedAt": "<string>",
"name": "<string>",
"phone": "<string>"
},
"success": true
}Headers
x-client-id
string
requiredYour client ID. This will be shared with you during onboarding.
x-client-secret
string
requiredYour secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!
Path Parameters
id
string
requiredThe unique ID for the requested carrier. Returned in Account and Policy objects as carrier.
Response
200 - application/json
data
object
success
boolean
Indicates whether the operation was performed successfully.
curl --request GET \
--url https://api.axle.insure/carriers/{id} \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'{
"data": {
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"country": "USA",
"postalCode": "30315",
"state": "Georgia"
},
"domain": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"modifiedAt": "<string>",
"name": "<string>",
"phone": "<string>"
},
"success": true
}