| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The Get Carrier by ID endpoint retrieves detailed information for a specific carrier or subsidiary using its unique ID. This is helpful when you need a complete view of a single entity, including address, MC and DOT numbers, insurance information, and current status.
Request Parameters
The following parameter is required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The version of the API being requested. |
| id | String | Yes | The unique identifier of the carrier. |
Example CURL Request
curl --location 'https://integrations.alvys.com/api/p/v{version}/carriers/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Replace {version} with the API version number, {Id} with the actual carrier ID, and YOUR_ACCESS_TOKEN with your actual Bearer token.
Response Parameters
The response contains a list of carriers or subsidiaries matching the search criteria, each represented by the following parameters:
| Parameter | Type | Description |
|---|---|---|
| Id | String (UUID) | The unique identifier of the carrier or subsidiary. |
| Name | String | The name of the carrier or subsidiary. |
| Address | Object | The address details (Street, City, State, ZipCode). |
| Address.Street | String | The street of the carrier’s address. |
| Address.City | String | The city of the carrier’s address. |
| Address.State | String | The state of the carrier’s address. |
| Address.ZipCode | String | The zip code of the carrier’s address. |
| McNum | String | The MC (Motor Carrier) number. |
| UsDotNum | String | The USDOT number. |
| ExternalName | String | External/QuickBooks name for accounting integration. Null if not set. |
| ExternalAccountReference | String | External/QuickBooks account reference. Null if not set or not available. |
| Type | String | Type of the entity (e.g., Carrier, Subsidiary). |
| Status | String | Current status of the carrier or subsidiary (e.g., Pending, Active, Packet Sent, Packet Completed, Do Not Load, Expired Insurance, Interested, Invited). |
| ExternalComplianceStatus | String | External compliance certification status (e.g., RMIS or MCP). Null if not set. |
| CreatedAt | String (Date-Time) | The creation date of the carrier/subsidiary record. |
| CreatedBy | String | The user who created the carrier. Null if not set. |
| Source | String | Source of carrier data (e.g., import, manual). Null if not set. |
| UpdatedAt | String (Date-Time) | The date and time of the last update. Null if not set. |
| Notes | Array of Objects | A list of notes about the carrier. Null or empty if not set. |
| SalesAgentId | String | The assigned sales agent ID. Null if not set. |
| ExternalIds | Array of Objects | External ID settings mapped from all external accounting ID settings. Null if none set. |
| PaymentMethod | String | Payment method for the carrier (e.g., "Factoring Company", "Direct Deposit", "Check"). Null if not set. |
| FactoringCompany | Object | Factoring company details if the carrier uses factoring. Null if not using factoring. |
| PaymentProvider | Object | Payment provider integration mapped to this carrier (e.g. TriumphPay). Null if not set. |
| Contacts | Array of Objects | Carrier contacts (name, email, phone, mobile, title). Null or empty if the carrier has no contacts. |
| InsuranceInfo | Array of Objects | A list of insurance policies associated with the carrier. |
| InsuranceInfo.Type | String | The type of insurance (e.g., Auto, Cargo, General, Workers Compensation). |
| InsuranceInfo.PolicyNumber | String | The insurance policy number. |
| InsuranceInfo.IssueDate | String (Date-Time) | The issue date of the insurance policy. |
| InsuranceInfo.ExpirationDate | String (Date-Time) | The expiration date of the insurance policy. |
| InsuranceInfo.Amount | Number | The coverage amount of the insurance policy. |
| InsuranceInfo.Agent | Object | Information about the insurance agent. |
| InsuranceInfo.Agent.Company | String | The name of the agent’s company. |
| InsuranceInfo.Agent.Name | String | The name of the insurance agent. |
| InsuranceInfo.Agent.Contact | Object | Contact details for the insurance agent (name, email, phone, mobile, title). |
| InsuranceInfo.Notes | String | Notes associated with the insurance policy. |
Example Response
{
"Id": "6c7f5ee3-f44c-4c19-92bf-89cfbd5d87a0",
"Name": "EVENT PRO LOGISTICS",
"Address": {
"Street": "3749 E 150 S",
"City": "TIPTON",
"State": "IN",
"ZipCode": "46072"
},
"McNum": "63504",
"UsDotNum": "4204692",
"Type": "Subsidiary",
"Status": "Active",
"CreatedAt": "2024-04-02T08:42:31.269118+00:00"
"InsuranceInfo": [
{
"Type": "Auto",
"PolicyNumber": "2445",
"IssueDate": "2024-11-14T00:00:00+00:00",
"ExpirationDate": "2030-11-14T00:00:00+00:00",
"Amount": 0.0,
"Agent": {
"Company": "PG Company",
"Name": ""
},
"Notes": ""
}
]
}Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section.
This page is interactive, allowing you to try a request by completing the fields for the parameters below. As you fill out the parameters, the CURL command on the right side of the page will be automatically updated. Alternatively, you can fork our Public API Postman Collection directly. Make sure to authorize yourself before trying a request.