Skip to main content
POST
Search carriers
The Search Carriers API endpoint helps users retrieve carrier or subsidiary details efficiently by filtering through available data using IDs, MC numbers, DOT numbers, and Status. This functionality provides quick access to essential carrier information without needing to query the full dataset.

Request Parameters

The following parameter is required in the URL path:

Request Body

The request body must include the following parameters: At least one filter field (Status, Ids, McNumbers, DotNumbers) must be provided along with pagination fields.

Example CURL Request

Use the current API version number and replace the Authorization header value 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:

Example Response


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.

Authorizations

Authorization
string
header
required

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 <token>.

Path Parameters

version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Body

Page
integer<int32>
required
PageSize
integer<int32>
required
Status
string[] | null
Ids
string[] | null
McNumbers
string[] | null
DotNumbers
string[] | null

Response

OK

Page
integer<int32>
required
PageSize
integer<int32>
required
Total
integer<int64>
required
Items
object[]
required
Facets
object | null