Carrier Management

Get carrier by ID

Fetch a carrier by its carrier ID. Returns the carrier with associated managers and contacts.

get/v1/carriers/{carrierId}

Request

Base URL
https://api.prod.goaugment.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/goaugment/apis/augment-api/docs/v1/carriers/:carrierId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

carrierIdstring required

Augment's carrier identifier, returned as carrierId in the create/update carrier response.

Response

Carrier found

idstring

Carrier ID (ULID)

namestring

Carrier name

tmsIdstring nullable

TMS identifier for the carrier

mcNumberinteger nullable

MC number

dotNumberinteger nullable

DOT number

scacstring nullable

SCAC code

emailstring nullable

Carrier email address

phonestring nullable

Phone number in E.164 format (e.g., +13125551234)

phoneExtensionstring nullable

Phone extension

notesstring nullable

Free-form notes about the carrier

customDataCarrierCustomData

Optional metadata for the carrier. Use string keys; each value may be a string, number, boolean, array of JSON-safe values, or nested object with the same rules. Omit or send {} when you have nothing to store.

Example response

{
  "customData": {
    "tier": "gold",
    "score": 98.5,
    "verified": true,
    "aliases": [
      "Acme Freight",
      "Acme Carriers LLC"
    ],
    "routing": {
      "defaultRegion": "NS",
      "allowCrossBorder": false
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.