gatego API documentation

GetById

GET /api/carrier/{id}

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)

Path parameters

id integer(int64) Required

id

Responses

• 200

OK
Hide response attributes Show response attributes object
- authorized boolean
- created_at string(date-time)
- created_by string
- fleet_id string
- id integer(int64)
- is_global boolean
- 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
  
  authorized boolean
  
  carrier_capacity integer(int64)
  
  yard_id integer(int64)
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/carrier/{id}

curl \
 -X GET https://api-dev.gatego.io:443/api/carrier/{id} \
 -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,
  "is_global": true,
  "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
    }
  ]
}