API referenceEndpoints
Search carriers
Returns carriers matching optional text, ticketing model, and status filters.
GET
/referential/v1/carriersReturns carriers matching optional text, ticketing model, and status filters.
Authorization
oauth2 AuthorizationBearer <token>
In: header
Query Parameters
search?string
Matches against carrier code, name and legal identifier.
Default
nullticketingModel?string
Who manages ticketing for the carrier.
Default
nullValue in
- "CARRIER_MANAGED"
- "STATION_MANAGED"
status?string
Carrier lifecycle status.
Default
nullValue in
- "ACTIVE"
- "SUSPENDED"
- "PENDING"
sort?string
Result ordering.
Default
nullValue in
- "nameAsc"
- "nameDesc"
- "newest"
- "oldest"
Response Body
*/*
curl -X GET "https://example.com/referential/v1/carriers"{ "data": [ { "id": "string", "code": "string", "name": "string", "ticketingModel": "string", "status": "string", "legalIdentifier": "string", "logo": "string", "website": "string", "phoneNumber": "string", "email": "string", "addressLine1": "string", "addressLine2": "string", "addressZip": "string", "addressCity": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}