List Orders

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

List all orders for the current workspace. Please refer to the API documentation for more information about the different types of orders and payment processors.

time	status	user agent
Retrieving recent requests…

Loading…

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

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

sort_property

string

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.

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

Response body

array of objects

object

integer

required

ClickFunnels Order ID

public_id

string | null

ClickFunnels Order public ID

order_number

string | null

A sequential number for bookkeeping purposes increased by 1 for each new order in a workspace starting from #1001.

workspace_id

integer

required

ClickFunnels Workspace ID

contact_id

integer

required

The contact associated with the order.

live_mode

boolean | null

Indicates if the Order will use a live payment gateway and process real credit cards, or if it will use a test gateway and only process test cards.

total_amount

string | null

The total amount of the order, considering taxes and discounts. For external orders, it's the sum of all line items' price amounts times their quantities.

currency

string

required

Currency

origination_channel_id

integer

required

Origination Channel ID

origination_channel_type

string | null

Origination Channel Type

shipping_address_first_name

string | null

The first name of the recipient's shipping address.

shipping_address_last_name

string | null

The last name of the recipient's shipping address.

shipping_address_organization_name

string | null

The organization name of the recipient's shipping address.

shipping_address_phone_number

string | null

The phone number of the recipient's shipping address.

shipping_address_street_one

string | null

The main street information of the shipping address, including the street name and number.

shipping_address_street_two

string | null

Additional street information for the shipping address, like entrance information and apartment numbers.

shipping_address_city

string | null

The city of the shipping address.

shipping_address_region

string | null

The region of the shipping address, like state or province.

shipping_address_country

string | null

The country of the shipping address.

shipping_address_postal_code

string | null

Postal Code

billing_address_street_one

string | null

The main street information of the billing address, including the street name and number.

billing_address_street_two

string | null

Additional street information of the billing address, like entrance information and apartment numbers.

billing_address_city

string | null

The city of the billing address.

billing_address_region

string | null

The region of the shipping address, like state or province.

billing_address_country

string | null

The billing address country.

billing_address_postal_code

string | null

Billing address postal (ZIP) code.

page_id

integer | null

Page ID

notes

string | null

Your internal note about the order. This will be visible in ClickFunnels admin orders-related sections.

in_trial

boolean | null

In Trial

billing_status

string | null

The billing status reflects the status of the invoice of an order.
Billing status can be one of the following for Payments AI orders: pending, draft, paid, unpaid, partially-refunded, refunded, voided, disputed, past-due.

For external orders, the billing status can be one of: pending, paid, unpaid, voided and refunded.

service_status

string | null

The service status reflects the activity state of the order. For subscriptions, it can control whether a subscription is ongoing, for example despite an irregular (unpaid) invoice status.

For orders with Payments AI as payment processor it can be one of the following:
pending, active, completed, churned, canceled, suspended, paused, abandoned

For external one-time orders the expected statuses are pending or completed.

order_type

string | null

Order Type

next_charge_at

string | null

Next Charge At

tax_amount

string | null

Tax Amount

trial_end_at

string | null

Trial End At

billing_payment_method_id

string | null

Payment Method

funnel_name

string | null

Funnel Name

tag_ids

array | null

Order Tags

tag_ids

discount_ids

array | null

Discounts

discount_ids

activated_at

string | null

Date Activated

workspace_sharing_id

string | null

Workspace Sharing ID

canceled_at

string | null

Order Canceled At

canceled_by

string | null

Order Canceled By

cancel_reason

string | null

The reason code for the cancelation, it is required when canceling an order.

Possible codes for Payments AI orders are:
did-not-use, did-not-want, missing-features, too-expensive, bugs-or-problems, other

cancel_description

string | null

A free-text description of the cancellation reason.

churned_at

string | null

Churned At

created_at

date-time | null

Date Ordered

updated_at

date-time | null

Date Updated

external_id

string | null

An external ID, e.g., a payment provider's ID or an ID managed by the client internally

payment_processor

string | null

The payment processor of the order. Currently, it can be one of payments_ai and external.

phone_number

string | null

Phone Number

page_name

string | null

Page Name. Want to filter by it? See our help guide on that topic.

origination_channel_name

string | null

Origination Channel Name

order_page

object | null

Page

contact

object

required

Contacts

contact_groups

array of objects | null

Contact Groups

contact_groups

object

integer

required

Group ID

public_id

string | null

Group Public ID

name

string

required

Name

workspace

object

required

Workspaces

segments

array of objects | null

Segments

segments

object

integer

required

Segment ID

public_id

string | null

Segment public ID

name

string

required

Name

line_items

array of objects | null

Order Line Items

line_items

object

integer

required

Line item ID

public_id

string | null

Line item public ID

order_id

integer

required

Order ID

quantity

integer | null

Quantity

prorated

string | null

Prorate invoice

created_at

string | null

Added

updated_at

string | null

Updated

original_product

object

required

Product

products_price

object

required

Product Price

products_variant

object | null

Product Variant

previous_line_item

string | null

An additional field, only available in outgoing subscription.upgrade/subscription.downgrade webhooks. It enables you to identify the former line item which is otherwise removed from the regular subscription line items when an upgrade or downgrade happens. Thus you can see the data of the previously active subscription. This property will not appear in regular API requests, but only in the event of a subscription upgrade or downgrade.

affiliate

object | null

The affiliate who will receive a commission for the order

referral_code

object | null

The referral code used to associate an order with an affiliate.

Headers

object

Pagination-Next

string

ID of the last item in the current response after which more records exist. You can use it in an after query parameter for cursor-based pagination to get to the next page.

Link

string

A direct link to the next page for the cursor-based pagination. It includes the after and the Pagination-Next ID value.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/workspaces/workspace_id/orders \
3
     --header 'accept: application/json'


xxxxxxxxxx
384
]
1
[
2
  {
3
    "id": 26,
4
    "public_id": "kDtNeI",
5
    "order_number": "729004",
6
    "workspace_id": 42000,
7
    "contact_id": 123,
8
    "live_mode": true,
9
    "total_amount": "123.00",
10
    "currency": "USD",
11
    "origination_channel_id": 30,
12
    "origination_channel_type": "User",
13
    "shipping_address_first_name": "Teodoro",
14
    "shipping_address_last_name": "Bartoletti",
15
    "shipping_address_organization_name": "Testing, Inc.",
16
    "shipping_address_phone_number": "+19053871234",
17
    "shipping_address_street_one": "653 Ferry Burg",
18
    "shipping_address_street_two": "Suite 301",
19
    "shipping_address_city": "South Anya",
20
    "shipping_address_region": "WA",
21
    "shipping_address_country": "US",
22
    "shipping_address_postal_code": "08181",
23
    "billing_address_street_one": "455 Harvey Glen",
24
    "billing_address_street_two": "Suite 420",
25
    "billing_address_city": "West Brock",

200OK

401Unauthorized

404Not Found