Skip to main content
GET
List Couriers

Authorizations

Authorization
string
header
required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand
string
required

Brand slug authorized by this API key.

Example:

"acme"

Query Parameters

cursor
string

Opaque nextCursor from the same collection and filters. Omit on the first request.

limit
integer
default:25
Required range: 1 <= x <= 100
name
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
accountNumber
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
isActive
enum<string>

Exact Boolean match. Use true or false.

Available options:
true,
false

Response

One page. totalItems counts the full filtered set; nextCursor null means exhausted.

items
object[]
required
nextCursor
string | null
required
totalItems
integer
required
Required range: 0 <= x <= 9007199254740991