List Orders

get

https://{subdomain}.myclickfunnels.com/api/v2/workspaces/{workspace_id}/orders

List all orders for the current workspace. Please refer to our Orders Overview guide for more information about the different types of orders and payment processors.

Path Params

workspace_id

integer

required

Query Params

after

string

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order

string

enum

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

Allowed:

sort_property

string

enum

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Allowed:

filter

object

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

Responses

Language

Credentials

Bearer

URL

Response

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

application/json

200OK

401Unauthorized

404Not Found