API ReferenceDocs
API Reference
Dashboard

List all Couriers

get
https://public-api.easyship.com/2024-09/couriers

Retrieve a list of active couriers.

Required authorization scope: public.courier:read

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
state
array of strings

Filter records by courier state.

state
string

Filter records by umbrella name.

boolean

Filter records to only those with available courier services.

boolean

Whether the courier belongs to Easyship or not.

Response

Updated 7 months ago

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

Updated 7 months ago