> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Get carrier > Retrieve a single carrier record by ID from Alvys, including MC and DOT numbers, contact details, insurance, safety data, and payment terms. 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 ```bash theme={null} 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 ```json theme={null} { "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](/docs/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](https://app.getpostman.com/run-collection/39138316-54c493c3-15e5-4fd7-a651-6e45b308548f?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D39138316-54c493c3-15e5-4fd7-a651-6e45b308548f%26entityType%3Dcollection%26workspaceId%3Dc0255544-5964-4c52-9d24-05b30a9b021c) directly. Make sure to authorize yourself before trying a request. ## OpenAPI ````yaml GET /api/p/v{version}/carriers/{id} openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/carriers/{id}: get: tags: - Carriers summary: Get carrier parameters: - name: id in: path required: true schema: type: string - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Alvys.Models.Carriers.CarrierResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Carriers.CarrierResponse: required: - Id - Name - Status - Type type: object properties: Id: type: string Name: type: string ExternalName: type: string nullable: true ExternalAccountReference: type: string nullable: true Address: allOf: - $ref: '#/components/schemas/Alvys.Features.Locations.ShortAddress' nullable: true McNum: type: string nullable: true UsDotNum: type: string nullable: true Type: type: string Status: type: string ExternalComplianceStatus: type: string nullable: true InsuranceInfo: type: array items: $ref: '#/components/schemas/Alvys.Models.InsuranceResponse' nullable: true CreatedAt: type: string format: date-time nullable: true CreatedBy: type: string nullable: true Source: type: string nullable: true UpdatedAt: type: string format: date-time nullable: true Notes: type: array items: $ref: '#/components/schemas/Alvys.Models.Notes.NoteDto' nullable: true SalesAgentId: type: string nullable: true ExternalIds: type: array items: $ref: '#/components/schemas/Alvys.Models.Carriers.ExternalIdResponse' nullable: true PaymentMethod: type: string nullable: true FactoringCompany: allOf: - $ref: >- #/components/schemas/Alvys.Models.Carriers.FactoringCompanyResponse nullable: true PaymentProvider: allOf: - $ref: >- #/components/schemas/Alvys.Models.Carriers.PaymentProviderResponse nullable: true Contacts: type: array items: $ref: '#/components/schemas/Alvys.Models.Customers.ContactResponse' nullable: true additionalProperties: false Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Features.Locations.ShortAddress: required: - City - State - Street - ZipCode type: object properties: Street: type: string City: type: string State: type: string ZipCode: type: string additionalProperties: false Alvys.Models.InsuranceResponse: required: - Amount - Notes - PolicyNumber - Type type: object properties: Agent: allOf: - $ref: '#/components/schemas/Alvys.Models.AgentResponse' nullable: true PolicyNumber: type: string IssueDate: type: string format: date-time nullable: true ExpirationDate: type: string format: date-time nullable: true Notes: type: string Type: type: string Amount: type: number format: double additionalProperties: false Alvys.Models.Notes.NoteDto: required: - Description - id - NoteType - User type: object properties: id: type: string Description: type: string NoteType: type: string Time: type: string format: date-time nullable: true User: type: string UserId: type: string nullable: true additionalProperties: false Alvys.Models.Carriers.ExternalIdResponse: required: - ExternalAccountingId type: object properties: SubsidiaryId: type: string nullable: true IntegrationId: type: string nullable: true ExternalAccountingId: type: string SubsidiaryName: type: string nullable: true IntegrationType: type: string nullable: true additionalProperties: false Alvys.Models.Carriers.FactoringCompanyResponse: required: - Id type: object properties: Id: type: string Name: type: string nullable: true additionalProperties: false Alvys.Models.Carriers.PaymentProviderResponse: required: - Id - Name type: object properties: Id: type: string Name: type: string additionalProperties: false Alvys.Models.Customers.ContactResponse: required: - Id - PrimaryContact type: object properties: Id: type: string Name: type: string nullable: true Email: type: string nullable: true Phone: type: string nullable: true Mobile: type: string nullable: true Extension: type: string nullable: true Title: type: string nullable: true PrimaryContact: type: boolean additionalProperties: false Alvys.Models.AgentResponse: required: - Name type: object properties: Company: type: string nullable: true Name: type: string Contact: allOf: - $ref: '#/components/schemas/Alvys.Models.Customers.ContactResponse' nullable: true additionalProperties: false securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as `Authorization: Bearer `. ````