Skip to main content
GET /v5/carrier-configs/ lists the carriers configured under Settings > Carriers. It’s the discovery endpoint for two identifiers the rest of the API expects:
  • carrier_reference — your name for one carrier configuration. This is what Create Shipment and Create Booking accept; an unconfigured value is rejected.
  • carrier_id — Perform.AI’s 6-character identifier for the carrier itself. Used as a filter in List Shipments and PUDO locations.
The same carrier can appear multiple times: one row per configuration, each with its own carrier_reference — for example a ups-outbound and a ups-returns account.
Notes:
  • Pagination is page-based with an unusually high ceiling: limit default 25, maximum 2000 — most accounts can fetch everything in one call.
  • carrier_description is optional and may be an empty string or null.
  • No configured carriers returns HTTP 200 with count: 0 and empty data; carriers are set up in the portal (contact your account team to add integrations).
Cache this list and refresh it periodically or on failure — don’t call it before every shipment creation. Carrier configurations change rarely, and an unknown carrier_reference error on create is your signal to refresh.