FreightCake
API Reference

Carriers

Carriers enabled for your account.

GET/api/v1/carriers

Returns the carriers enabled for your account.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.

In: header

Query Parameters

limit?integer

Page size. Defaults to a server-chosen value; maximum 100.

Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/carriers"
{  "object": "list",  "data": [    {      "object": "carrier",      "id": "string",      "name": "string",      "scac": "string",      "carrier_type": "string",      "enabled": true,      "logo_url": "string"    }  ],  "has_more": true,  "url": "/api/v1/carriers"}
GET/api/v1/carriers/{id}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.

In: header

Path Parameters

id*string

Resource identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/carriers/string"
{  "object": "carrier",  "id": "string",  "name": "string",  "scac": "string",  "carrier_type": "string",  "enabled": true,  "logo_url": "string"}