Get carrier by ID
API Refs
- Staging: Get carrier by ID
This endpoint returns detailed information about a specific carrier in your agency's account.
URI Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| id | number | The carrier ID | yes |
Response
| Name | Type | Description |
|---|---|---|
| id | number | Unique carrier identifier |
| firstName | string | First name of the carrier contact |
| lastName | string | Last name of the carrier contact |
| businessName | string | Carrier business name |
| string | Primary contact email | |
| commission | number | Commission percentage |
| address | object | Physical address information |
Address object
| Name | Type | Description |
|---|---|---|
| address1 | string | Primary address line |
| address2 | string | Secondary address line |
| city | string | City name |
| state | string | Two-letter US state code |
| postalCode | string | 5-digit postal code |
| phone | string | Contact phone number |
| alias | string | Reference name for this address |
Example
{
"id": 12345,
"firstName": "John",
"lastName": "Smith",
"businessName": "ABC Insurance Co",
"email": "[email protected]",
"commission": 15.0,
"address": {
"address1": "123 Main St",
"address2": "Suite 100",
"city": "Chicago",
"state": "IL",
"postalCode": "60601",
"phone": "312-555-0123",
"alias": "main-office"
}
}
Note: Commission rates can only be modified through the AgentSnap dashboard after creation.
Updated about 1 year ago
Did this page help you?