These docs are for v2023.01. Click to read the latest docs for v2024.09.

List all Courier Accounts

Retrieve a list of courier accounts.

Required authorization scope: Courier Account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Page number to fetch, default: 1

integer
1 to 100

Number of records per page to fetch, default: 20

string
enum

Sort records by listed columns. Default: created_at

Allowed:
string
enum

Set the sort direction. Default: DESC

Allowed:
country_alpha2
array of strings

Filter records by country code: Alpha-2 format (ISO 3166-1).

country_alpha2
string

An identifier for a customer (available only for selected customers)

auth_state
array of strings

Filter records by auth state.

auth_state
account_state
array of strings

Filter records by account state.

account_state
string

Filter records by umbrella name.

boolean

Filter records to only those with available couriers.

boolean

Whether the courier account belongs to Easyship or not.

Response

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json