ClickFunnels

ClickFunnels Order API

> Orders describe a purchase made by a contact. Please refer to the [Orders Overview Guide](https://developers.myclickfunnels.com/docs/orders) for more information. See the [Orders Skill](https://accounts.myclickfunnels.com/.well-known/orders/skill.md) for driving an existing order's lifecycle, including how to [cancel a subscription](https://accounts.myclickfunnels.com/.well-known/orders/skill.md#cancel-a-subscription) so it stops renewing at the payment processor.

GitHub OpenAPI

Operations 5

GET /workspaces/{workspace_id}/orders List Orders #
POST /workspaces/{workspace_id}/orders Create External Order #
GET /orders/{id} Fetch Order #
PUT /orders/{id} Update Order #
POST /orders/{id}/cancel Cancel Order #

Documentation

📖
Documentation
https://developers.myclickfunnels.com/docs/intro
📖
APIReference
https://developers.myclickfunnels.com/reference
📖
GettingStarted
https://developers.myclickfunnels.com/docs/getting-started
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/rate-limits/clickfunnels-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/openapi/clickfunnels-order-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/data-model/clickfunnels-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/errors/clickfunnels-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clickfunnels-order-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clickfunnels-order-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ClickFunnels Order API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Order
  description: '> Orders describe a purchase made by a contact.


    Please refer to the [Orders Overview Guide](https://developers.myclickfunnels.com/docs/orders) for more information.


    See the [Orders Skill](https://accounts.myclickfunnels.com/.well-known/orders/skill.md) for driving an existing order''s lifecycle, including how to [cancel a subscription](https://accounts.myclickfunnels.com/.well-known/orders/skill.md#cancel-a-subscription) so it stops renewing at the payment processor.

    '
paths:
  /workspaces/{workspace_id}/orders:
    get:
      tags:
      - Order
      summary: List Orders
      description: List all orders for the current workspace. Please refer to [our Orders Overview guide](https://developers.myclickfunnels.com/docs/orders) 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](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md#applying-existing-order-filters) in the [Refine Filters Skill](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md).
      operationId: listOrders
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      - name: stored_filter_id
        in: query
        required: false
        schema:
          type: string
        description: '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.'
      - name: stable_id
        in: query
        required: false
        schema:
          type: string
        description: '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](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md#applying-existing-order-filters) in the [Refine Filters Skill](https://accounts.myclickfunnels.com/.well-known/refine-filters/skill.md) for where to copy this token from and how to send it.'
      - name: filter
        in: query
        description: '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](https://developers.myclickfunnels.com/docs/filtering).

          '
        required: false
        schema:
          type: object
          properties:
            contact_id:
              type: string
              description: A comma-separated list of Contact IDs to filter by.
              example: 1,42
            id:
              type: string
              description: A comma-separated list of Order IDs to filter by.
              example: 1,42
            order_type:
              type: string
              description: The order type to filter by.
              enum:
              - subscription-order
              - one-time-order
              example: subscription-order
            live_mode:
              type: boolean
              description: 'Filter by live vs test orders: true for live/production orders, false for test orders.'
              example: false
        style: deepObject
        explode: true
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderAttributes'
              example:
              - id: 22642
                public_id: JmRRyN
                order_number: '#2146'
                workspace_id: 4
                contact_id: 22440
                live_mode: true
                total_amount: '396.00'
                currency: USD
                origination_channel_id: 11
                origination_channel_type: Platform::Application
                shipping_address_first_name: Caroll
                shipping_address_last_name: Kirlin
                shipping_address_organization_name: Testing, Inc.
                shipping_address_phone_number: '+19053871234'
                shipping_address_street_one: 3443 W Bavaria St
                shipping_address_street_two: ''
                shipping_address_city: Eagle
                shipping_address_region: ID
                shipping_address_country: US
                shipping_address_postal_code: '83616'
                billing_address_street_one: 3443 W Bavaria St
                billing_address_street_two: ''
                billing_address_city: Eagle
                billing_address_region: ID
                billing_address_country: US
                billing_address_postal_code: '83616'
                recurring_invoices_paid_count: 1
                page_id: null
                notes: For Fulfillment
                in_trial: false
                billing_status: pending
                service_status: completed
                order_type: one-time-order
                next_charge_at: null
                tax_amount: '0.00'
                trial_end_at: null
                billing_payment_method_id: null
                funnel_name: null
                tag_ids: []
                discount_ids: []
                activated_at: null
                workspace_sharing_id: null
                canceled_at: null
                canceled_by: null
                cancel_reason: null
                cancel_description: null
                churned_at: null
                paid_until: null
                resource_install_intent: null
                created_at: '2026-01-10T20:15:01.524Z'
                updated_at: '2026-01-10T20:15:01.524Z'
                external_id: cjnoxnqv1b
                payment_processor: external
                phone_number: null
                page_name: null
                origination_channel_name: Default API Client
                origination_channel_public_id: vNWWMb
                order_page: null
                contact:
                  id: 24359
                  public_id: vQxYMj
                  workspace_id: 4
                  anonymous: 0
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
                  time_zone: Madrid
                  uuid: 80b7f903-76cd-4edf-94bf-fc34c13ee654
                  unsubscribed_at: null
                  last_notification_email_sent_at: null
                  email_suppression_reason: null
                  is_active: true
                  fb_url: null
                  twitter_url: null
                  instagram_url: null
                  linkedin_url: null
                  website_url: null
                  created_at: '2026-01-09T15:27:56.647Z'
                  updated_at: '2026-01-09T15:28:08.075Z'
                  tags: []
                  custom_attributes: {}
                  visits:
                    first_visit:
                      uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
                      utm_source: google
                      utm_medium: cpc
                      utm_campaign: spring_sale
                      utm_term: running shoes
                      utm_content: ad_variant_a
                      ip: 192.168.1.1
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                      referrer: https://www.google.com/search?q=example
                      referring_domain: google.com
                      landing_page: https://example.com/products/shoes
                      browser: Chrome
                      os: Mac OS X
                      device_type: desktop
                      started_at: '2026-01-09T14:23:45.123Z'
                      created_at: '2026-01-09T14:23:45.123Z'
                      updated_at: '2026-01-09T14:23:45.123Z'
                    last_visit: null
                    last_visit_with_utm:
                      uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
                      utm_source: google
                      utm_medium: cpc
                      utm_campaign: spring_sale
                      utm_term: running shoes
                      utm_content: ad_variant_a
                      ip: 192.168.1.1
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                      referrer: https://www.google.com/search?q=example
                      referring_domain: google.com
                      landing_page: https://example.com/products/shoes
                      browser: Chrome
                      os: Mac OS X
                      device_type: desktop
                      started_at: '2026-01-09T14:23:45.123Z'
                      created_at: '2026-01-09T14:23:45.123Z'
                      updated_at: '2026-01-09T14:23:45.123Z'
                contact_groups:
                - id: 3
                  public_id: KekAjm
                  name: Default Group
                workspace:
                  id: 4
                  public_id: WjrGvk
                  team_id: 4
                  name: My Team
                  subdomain: myteam
                  created_at: '2025-05-26T09:56:16.307Z'
                  updated_at: '2026-01-08T17:40:21.676Z'
                segments: []
                line_items:
                - id: 674
                  public_id: GjPVnN
                  order_id: 22642
                  quantity: 2
                  prorated: null
                  created_at: '2026-01-10T20:15:01.536Z'
                  updated_at: '2026-01-10T20:15:01.536Z'
                  original_product:
                    id: 6512
                    public_id: YRnzRY
                    name: Seinfeld In Your Pocket - Comedy Joke Machine (Black Premium)
                  products_price:
                    id: 22229
                    public_id: YqEWxY
                    amount: '198.00'
                    currency: usd
                    duration: null
                    interval: null
                    interval_count: null
                    key: null
                  products_variant:
                    id: 22228
                    public_id: JdknyN
                    name: Seinfeld In Your Pocket - Comedy Joke Machine (Black Premium)
                    description: null
                    sku: SIYP-BLACK-PREMIUM-001
                previous_line_item: null
                visits:
                  last_visit:
                    uuid: 7a3f9c11-2d45-4e23-88d2-1bef9acd44fa
                    utm_source: null
                    utm_medium: null
                    utm_campaign: null
                    utm_term: null
                    utm_content: null
                    ip: 192.168.1.1
                    user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                    referrer: https://www.clickfunnels.com/products
                    referring_domain: clickfunnels.com
                    landing_page: https://example.com/checkout
                    browser: Chrome
                    os: Mac OS X
                    device_type: desktop
                    started_at: '2026-01-10T20:10:15.234Z'
                    created_at: '2026-01-10T20:10:15.234Z'
                    updated_at: '2026-01-10T20:10:15.234Z'
                  last_visit_with_utm:
                    uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
                    utm_source: google
                    utm_medium: cpc
                    utm_campaign: spring_sale
                    utm_term: running shoes
                    utm_content: ad_variant_a
                    ip: 192.168.1.1
                    user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                    referrer: https://www.google.com/search?q=example
                    referring_domain: google.com
                    landing_page: https://example.com/products/shoes
                    browser: Chrome
                    os: Mac OS X
                    device_type: desktop
                    started_at: '2026-01-09T14:23:45.123Z'
                    created_at: '2026-01-09T14:23:45.123Z'
                    updated_at: '2026-01-09T14:23:45.123Z'
                affiliate: null
                referral_code: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
        '422':
          description: Unprocessable Entity — `stored_filter_id` is unknown, invalid, belongs to a different workspace, or is not an order filter; or `stable_id` is malformed, is not an order filter, mixes `and`/`or` across its conditions, or references records outside this workspace.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: stable_id is not a valid serialized filter
    post:
      tags:
      - Order
      summary: Create External Order
      description: Create a new [external order](https://developers.myclickfunnels.com/docs/orders#external-orders) in the current workspace. This is useful if you process payments outside of ClickFunnels, but still want to make use of ClickFunnels' automations and funnels. You can gain even more functionality by creating invoices for your new orders. It is currently only possible to create invoices with the 'external' payment processor type. Other payment processors like 'payments_ai' are not yet supported. Refer to the corresponding guide for more information [here](https://developers.myclickfunnels.com/docs/orders#external-orders).
      operationId: createOrders
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Order
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  $ref: '#/components/schemas/OrderParameters'
            example:
              order:
                order_type: one-time-order
                live_mode: true
                contact_id: 10
                line_items_attributes:
                - variant_id: 15
                  products_price_id: 23
                  quantity: 1
                - variant_id: 18
                  products_price_id: 29
                  quantity: 2
                shipping_address_first_name: Elmira
                shipping_address_last_name: O'Keefe
                shipping_address_organization_name: Testing, Inc.
                shipping_address_phone_number: '+19053871234'
                shipping_address_street_one: 687 Volkman Trail
                shipping_address_street_two: Suite 665
                shipping_address_city: New Ezequiel
                shipping_address_region: WA
                shipping_address_country: US
                shipping_address_postal_code: '93706'
                billing_address_street_one: 3537 Meridith Overpass
                billing_address_street_two: Apt. 787
                billing_address_city: Tyraside
                billing_address_region: WA
                billing_address_country: US
                billing_address_postal_code: 48869-5657
                notes: Leave package at the front desk
                billing_status: pending
                service_status: pending
                external_id: ext-order-12345
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderAttributes'
              example:
                id: 22642
                public_id: JmRRyN
                order_number: '#2146'
                workspace_id: 4
                contact_id: 22440
                live_mode: true
                total_amount: '396.00'
                currency: USD
                origination_channel_id: 11
                origination_channel_type: Platform::Application
                shipping_address_first_name: Caroll
                shipping_address_last_name: Kirlin
                shipping_address_organization_name: Testing, Inc.
                shipping_address_phone_number: '+19053871234'
                shipping_address_street_one: 3443 W Bavaria St
                shipping_address_street_two: ''
                shipping_address_city: Eagle
                shipping_address_region: ID
                shipping_address_country: US
                shipping_address_postal_code: '83616'
                billing_address_street_one: 3443 W Bavaria St
                billing_address_street_two: ''
                billing_address_city: Eagle
                billing_address_region: ID
                billing_address_country: US
                billing_address_postal_code: '83616'
                recurring_invoices_paid_count: 1
                page_id: null
                notes: For Fulfillment
                in_trial: false
                billing_status: pending
                service_status: completed
                order_type: one-time-order
                next_charge_at: null
                tax_amount: '0.00'
                trial_end_at: null
                billing_payment_method_id: null
                funnel_name: null
                tag_ids: []
                discount_ids: []
                activated_at: null
                workspace_sharing_id: null
                canceled_at: null
                canceled_by: null
                cancel_reason: null
                cancel_description: null
                churned_at: null
                paid_until: null
                resource_install_intent: null
                created_at: '2026-01-10T20:15:01.524Z'
                updated_at: '2026-01-10T20:15:01.524Z'
                external_id: cjnoxnqv1b
                payment_processor: external
                phone_number: null
                page_name: null
                origination_channel_name: Default API Client
                origination_channel_public_id: vNWWMb
                order_page: null
                contact:
                  id: 24359
                  public_id: vQxYMj
                  workspace_id: 4
                  anonymous: 0
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
                  time_zone: Madrid
                  uuid: 80b7f903-76cd-4edf-94bf-fc34c13ee654
                  unsubscribed_at: null
                  last_notification_email_sent_at: null
                  email_suppression_reason: null
                  is_active: true
                  fb_url: null
                  twitter_url: null
                  instagram_url: null
                  linkedin_url: null
                  website_url: null
                  created_at: '2026-01-09T15:27:56.647Z'
                  updated_at: '2026-01-09T15:28:08.075Z'
                  tags: []
                  custom_attributes: {}
                  visits:
                    first_visit:
                      uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
                      utm_source: google
                      utm_medium: cpc
                      utm_campaign: spring_sale
                      utm_term: running shoes
                      utm_content: ad_variant_a
                      ip: 192.168.1.1
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                      referrer: https://www.google.com/search?q=example
                      referring_domain: google.com
                      landing_page: https://example.com/products/shoes
                      browser: Chrome
                      os: Mac OS X
                      device_type: desktop
                      started_at: '2026-01-09T14:23:45.123Z'
                      created_at: '2026-01-09T14:23:45.123Z'
                      updated_at: '2026-01-09T14:23:45.123Z'
                    last_visit: null
                    last_visit_with_utm:
                      uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
                      utm_source: google
                      utm_medium: cpc
                      utm_campaign: spring_sale
                      utm_term: running shoes
                      utm_content: ad_variant_a
                      ip: 192.168.1.1
                      user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                      referrer: https://www.google.com/search?q=example
                      referring_domain: google.com
                      landing_page: https://example.com/products/shoes
                      browser: Chrome
                      os: Mac OS X
                      device_type: desktop
                      started_at: '2026-01-09T14:23:45.123Z'
                      created_at: '2026-01-09T14:23:45.123Z'
                      updated_at: '2026-01-09T14:23:45.123Z'
                contact_groups:
                - id: 3
                  public_id: KekAjm
                  name: Default Group
                workspace:
                  id: 4
                  public_id: WjrGvk
                  team_id: 4
                  name: My Team
                  subdomain: myteam
                  created_at: '2025-05-26T09:56:16.307Z'
                  updated_at: '2026-01-08T17:40:21.676Z'
                segments: []
                line_items:
                - id: 674
                  public_id: GjPVnN
                  order_id: 22642
                  quantity: 2
                  prorated: null
                  created_at: '2026-01-10T20:15:01.536Z'
                  updated_at: '2026-01-10T20:15:01.536Z'
                  original_product:
                    id: 6512
                    public_id: YRnzRY
                    name: Seinfeld In Your Pocket - Comedy Joke Machine (Black Premium)
                  products_price:
                    id: 22229
                    public_id: YqEWxY
                    amount: '198.00'
                    currency: usd
                    duration: null
                    interval: null
                    interval_count: null
                    key: null
                  products_variant:
                    id: 22228
                    public_id: JdknyN
                    name: Seinfeld In Your Pocket - Comedy Joke Machine (Black Premium)
                    description: null
                    sku: SIYP-BLACK-PREMIUM-001
                previous_line_item: null
                visits:
                  last_visit:
                    uuid: 7a3f9c11-2d45-4e23-88d2-1bef9acd44fa
                    utm_source: null
                    utm_medium: null
                    utm_campaign: null
                    utm_term: null
                    utm_content: null
                    ip: 192.168.1.1
                    user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                    referrer: https://www.clickfunnels.com/products
                    referring_domain: clickfunnels.com
                    landing_page: https://example.com/checkout
                    browser: Chrome
                    os: Mac OS X
                    device_type: desktop
                    started_at: '2026-01-10T20:10:15.234Z'
                    created_at: '2026-01-10T20:10:15.234Z'
                    updated_at: '2026-01-10T20:10:15.234Z'
                  last_visit_with_utm:
                    uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
                    utm_source: google
                    utm_medium: cpc
                    utm_campaign: spring_sale
                    utm_term: running shoes
                    utm_content: ad_variant_a
                    ip: 192.168.1.1
                    user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
                    referrer: https://www.google.com/search?q=example
                    referring_domain: google.com
                    landing_page: https://example.com/products/shoes
                    browser: Chrome
                    os: Mac OS X
                    device_type: desktop
                    started_at: '2026-01-09T14:23:45.123Z'
                    created_at: '2026-01-09T14:23:45.123Z'
                    updated_at: '2026-01-09T14:23:45.123Z'
                affiliate: null
                referral_code: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
  /orders/{id}:
    get:
      tags:
      - Order
      summary: Fetch Order
      description: Retrieve a specific order in the current workspace. Please refer to [our Orders Overview guide](https://developers.myclickfunnels.com/docs/orders) for more information about the different types of orders and payment processors.
      operationId: getOrders
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderAttributes'
              example:
                id: 22642
                public_id: JmRRyN
                order_number: '#2146'
                workspace_id: 4
                contact_id: 22440
                live_mode: true
                total_amount: '396.00'
                currency: USD
                origination_channel_id: 11
                origination_channel_type: Platform::Application
                shipping_address_first_name: Caroll
                shipping_address_last_name: Kirlin
                shipping_address_organization_name: Testing, Inc.
                shipping_address_phone_number: '+19053871234'
                shipping_address_street_one: 3443 W Bavaria St
                shipping_address_street_two: ''
                shipping_address_city: Eagle
                shipping_address_region: ID
                shipping_address_country: US
                shipping_address_postal_code: '83616'
                billing_address_street_one: 3443 W Bavaria St
                billing_address_street_two: ''
                billing_address_city: Eagle
                billing_address_region: ID
                billing_address_country: US
                billing_address_postal_code: '83616'
                recurring_invoices_paid_count: 1
                page_id: null
                notes: For Fulfillment
                in_trial: false
                billing_status: pending
                service_status: completed
                order_type: one-time-order
                next_charge_at: null
                tax_amount: '0.00'
                trial_end_at: null
                billing_payment_method_id: null
                funnel_name: null
                tag_ids: []
                discount_ids: []
                activated_at: null
                workspace_sharing_id: null
                canceled_at: null
                canceled_by: null
                cancel_reason: null
                cancel_description: null
                churned_at: null
                paid_until: null
                resource_install_intent: null
                created_at: '2026-01-10T20:15:01.524Z'
                updated_at: '2026-01-10T20:15:01.524Z'
                external_id: cjnoxnqv1b
                payment_processor: external
                phone_number: null
                page_name: null
                origination_channel_name: Default API Client
                origination_channel_public_id: vNWWMb
                order_page: null
                contact:
                  id: 24359
                  public_id: vQxYMj
                  workspace_id: 4
                  anonymous: 0
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
                  time_zone: Madrid
                  uuid: 80b7f903-76cd-4edf-94bf-fc34c13ee654
                  unsubscribed_at: null
                  last_notification_email_sent_at: null
                  email_suppression_reason: null
                  is_active: true
                  fb_url: null
                  twitter_url: null
                  instagram_url: null
                  linkedin_url: null
                  website_url: null
                  created_at: '2026-01-09T15:27:56.647Z'
                  updated_at: '2026-01-09T15:28:08.075Z'
                  tags: []
                  custom_attributes: {}
                  visits:
                    first_visit:
                      uuid: 9f2e8a22-1b65-4414-95f3-5caf0bbd11da
       

# --- truncated at 32 KB (129 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/openapi/clickfunnels-order-api-openapi.yml