List 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. To apply an order filter that already exists in ClickFunnels, pass stored_filter_id or stable_id, see Applying existing order filters in the Refine Filters Skill.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

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

string
enum

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

Allowed:
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:
string

The id (integer) or public_id (string) of a saved order filter scoped to this workspace. Existing saved filters can be discovered with GET /api/v2/workspaces/{workspace_id}/refine_filters; choose an entry whose filter_class is OrdersFilter. Applies the saved filter's criteria to the results, composed (AND) with any filter[...] params.
Returns 422 if the filter is unknown, invalid, belongs to a different workspace, or is not an order filter. When both stored_filter_id and stable_id are supplied, stable_id takes precedence.

string

A URL-encoded Refine stable_id token copied from a filtered ClickFunnels Orders page. Send it as a normally encoded query parameter; do not decode it or concatenate its raw value into a URL. Applies the encoded order-filter criteria to the results, composed (AND) with any filter[...] params.
Returns 422 if the token is malformed, is not an order filter, mixes and/or across its conditions, or references records outside this workspace. Flat filters and grouped filters using a single conjunction (including tokens copied from the filtered Orders UI) are supported; mixing the two words is rejected whether or not the token groups its criteria, because a flat filter cannot express it. When both selectors are supplied, stable_id takes precedence.
See Applying existing order filters in the Refine Filters Skill for where to copy this token from and how to send it.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json