v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Carriers

List Carriers

List all carriers within the specified account.

get/public/v3/Carriers

Query parameters

Namestring

Filter results by the name of the carrier.

Mode'Road' | 'Ocean' | 'Air' | 'Rail'

The mode of transportation. Valid modes are Road, Ocean, Air, or Rail.

Filter results by the mode of transportation. Valid modes are Road, Ocean, Air, or Rail.

PageSizeinteger

The number of results to retrieve. Default and maximum is 50.

PageNumberinteger

The page number to use. This is needed when there are more objects than the max page size. The default is 1.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested carriers

totalRecordsinteger
pageNumberinteger
pageSizeinteger
nextstring nullable
previousstring nullable