Returns the carrier or carriers that match all the parameters conditions

GET /api/carrier/search

The match must be exact and at least one condition is mandatory. No visibility rules are applied, this method searches in the whole carrier list in Database, regardless the user organization

Headers

  • X-Gatego-oid

    Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

Responses

GET /api/carrier/search 
curl \
 -X GET https://api-dev.gatego.io:443/api/carrier/search \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "authorized": true,
    "created_at": "2023-05-04T09:42:00+00:00",
    "created_by": "string",
    "fleet_id": "string",
    "id": 42,
    "last_modified_at": "2023-05-04T09:42:00+00:00",
    "last_modified_by": "string",
    "name": "string",
    "rfc": "string",
    "scac": "string",
    "usdot": "string",
    "yards": [
      {
        "authorized": true,
        "carrier_capacity": 42,
        "yard_id": 42
      }
    ]
  }
]