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

name string

name
usdot string

usdot
scac string

scac
rfc string

rfc

Responses

200 */*

OK
Hide response attributes Show response attributes object
- address string
- address_additional_info string
- authorized boolean
- created_at string(date-time)
- created_by string
- email string
- fleet_id string
- id integer(int64)
- last_modified_at string(date-time)
- last_modified_by string
- name string
- rfc string
- scac string
- usdot string
- yards array[object]
  
  Hide yards attributes Show yards attributes object
  
  authorized boolean
  
  carrier_capacity integer(int64)
  
  yard_id integer(int64)
401

Unauthorized
403

Forbidden
404

Not Found

GET /api/carrier/search

curl \
 -X GET http://127.0.0.1:8080/api/carrier/search

Response examples (200)

[
  {
    "address": "string",
    "address_additional_info": "string",
    "authorized": true,
    "created_at": "2024-05-04T09:42:00+00:00",
    "created_by": "string",
    "email": "string",
    "fleet_id": "string",
    "id": 42,
    "last_modified_at": "2024-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
      }
    ]
  }
]