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

List all Courier Accounts

get

https://api.easyship.com/2023-01/courier_accounts

Retrieve a list of courier accounts.

Required authorization scope: Courier Account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Page number to fetch, default: 1

per_page

integer

1 to 100

Number of records per page to fetch, default: 20

sort_by

string

enum

Sort records by listed columns. Default: created_at

Allowed:

sort_direction

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

customer_reference_id

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

umbrella_name

string

Filter records by umbrella name.

active_couriers

boolean

Filter records to only those with available couriers.

easyship_account

boolean

Whether the courier account belongs to Easyship or not.

Response

Language

Credentials

Bearer

token

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200list of courier accounts