ClickFunnels
ClickFunnels is a sales funnel and online business platform that lets entrepreneurs build landing pages, sales funnels, checkout flows, courses, membership sites, communities, blogs and email marketing campaigns without code. The ClickFunnels 2.0 REST API is a 418-operation OpenAPI 3.1 contract covering teams, workspaces, funnels, pages, blogs, products, discounts, orders, invoices, transactions, subscriptions, contacts, courses, communities, forms, workflows, email and analytics, authenticated with a team-scoped Bearer token or with workspace-scoped OAuth 2.0. It is discoverable the correct way: an RFC 9727 api-catalog links the spec, RFC 8414 metadata publishes the OAuth scopes, and sixteen Markdown Agent Skills are served from /.well-known/ for agents driving the API.
ClickFunnels publishes 102 APIs on the APIs.io network, including Addresses::Country API, Addresses::Region API, Appointments::Scheduled Event API, and 99 more. Tagged areas include Sales Funnels, Landing Pages, E-Commerce, Marketing, and Checkout.
The ClickFunnels catalog on APIs.io includes 1 event-driven AsyncAPI specification.
ClickFunnels’ developer surface includes authentication, changelog, CLI, sandbox, documentation, API reference, getting-started guide, and 38 more developer resources.
2 APIs
Individual APIs this provider publishes, each with its own machine-readable definition.
> Countries are a global reference list used when setting addresses. The Addresses::Country API provides read-only access to the list of countries, each with its ISO 3166-1 alph...
> Regions are the states/provinces of a country. The Addresses::Region API provides read-only access to the regions of a country. Use a region's code or name as the address regi...
> Scheduled Appointment Events represent set meeting events The Appointment Scheduled Event represents a scheduled meeting between a ClickFunnels user and a contact on a specifi...
> Blogs represent a blog resource belonging to a workspace site A Blog is a top-level container for blog posts, categories, tags, and authors. Each workspace site can have one o...
Blog Authors. See [Authors (read-only)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#authors-read-only) in the [Blogs Skill](https://accounts.myclickfunnels.co...
Blog Categories. See [Categories (read-only)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#categories-read-only) in the [Blogs Skill](https://accounts.myclickf...
> Blog Posts are the individual articles published within a Blog Blog posts support rich content via PML markup, visibility controls, SEO settings, categories, tags, and authors...
Blog Tags. See [Tags (list / show / create)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#tags-list--show--create) in the [Blogs Skill](https://accounts.myclic...
> Bans prevent a Contact from accessing a Community. A Ban records which Contact is banned, who issued the ban, the scope of the ban (`bannable_type`/`bannable_id`), and an opti...
> Async bulk action that exports community ban data to a file in the background. Creating an ExportAction enqueues a background job and immediately returns an action record. Pol...
> Async bulk action that unbans multiple contacts from a community in the background. Creating an UnbanAction enqueues a background job and immediately returns an action record....
> Memberships represent a Contact's membership in a Community. A Membership joins a Contact to a Community and tracks whether that member has moderator privileges. Creating or u...
> Async bulk action that adds multiple members to one or more community spaces (groups) in the background. Creating an AddToGroupAction enqueues a background job and immediately...
> Async bulk action that bans multiple community members in the background. Creating a BanAction enqueues a background job and immediately returns an action record. Poll the `sh...
> Async bulk action that exports community membership data to a file in the background. Creating an ExportAction enqueues a background job and immediately returns an action reco...
> Async bulk action that removes multiple members from one or more community spaces (groups) in the background. Creating a RemoveFromGroupAction enqueues a background job and im...
> Spaces (Topics) are the individual discussion areas within a Space Group. A Space is a single discussion channel or topic area within a Space Group. Members post, comment, and...
> Space Groups are named sections within a Community that contain Spaces (Topics). A Space Group is a logical grouping of Spaces (Topics) within a Community. Use Space Groups to...
> Posts are member-created content items within a Community Space. A Post belongs to a Space and is authored by a Contact. Posts support rich HTML body content, optional titles,...
> Comments are member replies on a Community Post. A Comment belongs to a Post and is authored by a Contact. Comments support rich HTML body content and threaded replies via `pa...
> Comment Likes record a Contact's like reaction on a Post Comment. A Comment Like belongs to a Comment and is authored by a Contact. Likes have no update operation — create one...
> Post Likes record a Contact's like reaction on a Community Post. A Post Like belongs to a Post and is authored by a Contact. Likes have no update operation — create one to lik...
> Video Embeds attach a hosted video to a Community Post. A Video Embed belongs to a Post and stores the provider name, source URL, and optional provider-specific metadata. Vide...
> Communities are membership-based spaces where contacts can post, interact, and engage. A Community is the top-level container for community content. It belongs to a workspace ...
> Contact Applied Tags The Contact Applied Tags APIs allow you to list, apply and remove tags associated with a specific contact. To utilize this, first obtain the Tag IDs for a...
> Bulk-enroll contacts into course sections An Enroll Action enrolls an entire audience of contacts into one or more course sections in a single async operation. Pass `course_id...
> Bulk-export contacts to a CSV file An Export Action generates a CSV of an audience of contacts in a single async operation. Supply `fields` to control which contact columns ap...
> AI-generated contact filters Translate a natural-language audience description into a ClickFunnels contact filter using an AI model. The model can use the full range of contac...
> Bulk-trigger a workflow across a filtered set of contacts A Run Workflow Action enqueues an entire audience of contacts into a workflow in a single async operation. Requires a...
# Contact Tags Contact Tags are unique to each workspace, allowing for customized organization of your Contacts. Once created, these tags can be applied to any contact within th...
> Bulk apply or remove tags across a filtered set of contacts A Tag Action applies (or removes) one or more Contact Tags across an entire audience in a single async operation. I...
> Bulk-unsubscribe contacts from email An Unsubscribe Action marks an entire audience of contacts as unsubscribed from email in a single async operation. **Target selection** — ...
> Represents the volume of educational material The course is the top-level layer of a concept for educational material. It is the _thing_ to be sold to a customer. Once a custo...
> Controls access to course sections and lessons By purchasing or otherwise opting into a course, an enrollment record is created. Enrollments dictate which sections, sub-sectio...
> Represents the material within a Course The lesson is the part of the course which teaches the material described within the course. Completing lessons can unlock access to ot...
> Marks a lesson as completed for enrollment. To mark a lesson as completed by an enrollment, create an `Courses::LessonCompletion` record. To undo this, the `Courses::LessonCom...
> Represents the modules within a Course The section is the organization layer of a course where the content is accessed and managed for a customer. Sections can have sub-sectio...
> Publishes course sections (and their lessons) in bulk. A Publish Action selects one or more course sections — either by explicit `target_ids` (course-section public IDs) or `t...
> A reusable, workspace-scoped discount the checkout applies on top of a price. A Discount is the right tool for a coupon code, a percentage/amount off, or a time-boxed sale - a...
> Domains represent custom domains connected to a workspace. The Domains API provides read-only access to the domains configured for a workspace. Use this API to look up domain ...
> Downloads are workspace files that can be granted through product variants. Use the Download's `asset_id` when configuring digital-asset access through the `Products::Variant`...
> Email Addresses Email Addresses represent sender addresses in your workspace. These are used as "from" and "reply-to" addresses when sending email broadcasts. Select a from-ad...
> Email Broadcasts Email Broadcasts allow you to send one-time email campaigns to your contacts. Broadcasts are created in draft status and can be sent immediately or scheduled ...
> Send Actions trigger the actual delivery of an email broadcast. A Send Action is the trigger that sends (or schedules) the parent broadcast — the same action the ClickFunnels ...
> Email Domains represent the sending domains (DKIM/SPF/DMARC) available to a workspace for outbound email. One domain name has two independent jobs, and sending needs both. Thi...
> Email Settings Email Settings represent your workspace's email configuration, including default from and reply-to addresses for system and marketing emails. See the [Business ...
> Email Templates Email Templates are reusable email content that can be used with broadcasts. See [Templates](https://accounts.myclickfunnels.com/.well-known/emails/skill.md#te...
> Email Topics Email Topics are used for email broadcast categorization and subscriber preferences. See [Sending or scheduling a broadcast](https://accounts.myclickfunnels.com/....
> Manage Forms, FieldSets, Fields, Submissions and Answers The Forms API and it's related resources allow you to manage in detail all parts of your ClickFunnels forms.
> Allows to submit and analyze forms programmatically The `Forms::Submission` resource together with the `Form` and other `Forms::` allows you to create form submission programm...
> Presents submitted forms including the detailed data breakdown The `FormSubmission` resource is a log of all the form submissions that happened for a given workspace. You can ...
> Fulfillments allow fulfilling orders and managing shipments. Please refer to [our Fulfillments guide](https://developers.myclickfunnels.com/docs/fulfillments) for more informa...
> The Funnel resource contains relevant metadata about funnels. Funnel-level analytics are available via the Fetch Funnel Stats endpoint (`GET /funnels/{funnel_id}/stats`); per-...
> Conditional split steps route contacts down a "matched" or "unmatched" branch based on a RefineFilter condition. Conditional split steps live inside a funnel's workflow. Each ...
> Split test steps wrap an existing funnel page in a two-branch A/B split with configurable traffic weights. Split test steps live inside a funnel's workflow. Each step exposes ...
> Funnels::Tag are used to distinguish, segment and run additional automations on your funnels and the users who go through them.
> Images can be used in a variety of use cases. An image can be created or updated from a URL by defining the `upload_source_url` parameter. The response returns the hosted `url...
> 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 [Ord...
> Order Applied Tags The Order Applied Tags APIs allow you to list, apply and remove tags associated with a specific order. To utilize this, first obtain the Tag IDs for all the...
> Invoices track payments for orders. Order Invoices are the invoices issued against Orders. For more information please consult our [Orders Overview guide](https://developers.m...
> Restocks make it possible to restock in case a priorly issued fulfillment is not going to be fulfilled. If a customer pays for an invoice that will not get fulfilled (e.g. the...
> Preview and commit variant/price changes on existing subscription line items. A self-serve flow for switching the variant or price on a subscription line item. The surface has...
> Order Tags Order Tags are unique to each workspace, allowing for customized organization of your orders. Once created, these tags can be applied to any order within the same w...
> Page offers extra information about ClickFunnels pages, like those that are part of funnels. It's the main element that the user modifies when editing a Page in the ClickFunne...
> Products can be used to create and edit sellable goods. Products have a few boolean attributes including `archived`, `visible_in_store`, and `visible_in_customer_center`. Prod...
> Allowed variant/price upgrade and downgrade targets for a source price. Merchant-configured rows define which variant + price combinations a subscription using a given source ...
> Product variants If there are multiple variants of a product (like when a T-shirt can come in many sizes or colors), then these should be created as `Products::Variant` record...
> Reusable audience filters that scope contacts for conditional splits, email broadcasts, workflow branches, and other ClickFunnels surfaces. A RefineFilter stores a named, conj...
> Sales Opportunities Sales Opportunities are initially created in a specific stage of a Pipeline and can be moved between different stages within that Pipeline. Each Sales Oppo...
> Sales Pipelines Pipelines allow you to organize, track and advance Opportunies between different Stages. A Pipeline consists of multiple Stages. When creating a Pipeline, you ...
> Sales Pipeline Stages Stages belong to a Pipeline, and allow you to track and advance Opportunities. You can re-order Stages in a Pipeline by updating the `sort_order` attribu...
> Sites represent a workspace's website configuration containing global code settings.
> Styles determine some CSS specifics for a theme.
> Themes determine the look of the user-facing ClickFunnels pages. A theme bundles the relevant site pages, like home page, storefront, course pages, etc.
Webhook Outgoing Endpoints
The authoritative catalog of webhook event types available for subscription. Use this endpoint to discover the exact string keys to supply in `event_type_ids` when creating or u...
Standalone automation workflows that enroll contacts and execute a sequence of action steps (send email, apply tag, delay, split, etc.). A workflow is either `draft` (no active ...
Execution records tracking a contact's progress through a workflow. Status is derived: `active`, `paused`, `completed`, or `canceled`. Runs can be listed/filtered or manually cr...
Action and split steps within a workflow. The step `type` (e.g. `send_email_step`, `delay_step`, `conditional_split_step`) is conveyed via the `step_type_settings` map — the sin...
Triggers attached to a workflow. Each trigger specifies an `event_type_key` (e.g. `$contact.tag_applied`) and optional condition FK ids that narrow which events fire the trigger...
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
Recommended x-agentic-access execution contracts for AI agents.
aid: clickfunnels
name: ClickFunnels
description: 'ClickFunnels is a sales funnel and online business platform that lets entrepreneurs build landing pages, sales
funnels, checkout flows, courses, membership sites, communities, blogs and email marketing campaigns without code. The ClickFunnels
2.0 REST API is a 418-operation OpenAPI 3.1 contract covering teams, workspaces, funnels, pages, blogs, products, discounts,
orders, invoices, transactions, subscriptions, contacts, courses, communities, forms, workflows, email and analytics, authenticated
with a team-scoped Bearer token or with workspace-scoped OAuth 2.0. It is discoverable the correct way: an RFC 9727 api-catalog
links the spec, RFC 8414 metadata publishes the OAuth scopes, and sixteen Markdown Agent Skills are served from /.well-known/
for agents driving the API.'
type: Index
deliveryModel:
model: unknown
open_source: unknown
commercial: true
callable_host: false
label: Delivery model not determined — needs a product licence on record
confidence: low
source:
- pricing
- repository-unlicensed
generated: '2026-08-28'
method: derived
accessModel:
pricing: unknown
onboarding: self-serve
trial: false
try_now: false
public: false
label: Self-serve signup
confidence: medium
source:
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/clickfunnels.png
tags:
- Sales Funnels
- Landing Pages
- E-Commerce
- Marketing
- Checkout
- CRM
- Email Marketing
- Online Courses
- Webhook
- Website Builder
- Subscription
- Marketing Automation
- Agent Skills
tags_raw:
- Sales Funnels
- Landing Pages
- E-commerce
- Marketing
- Checkout
- CRM
- Email Marketing
- Online Courses
- Webhooks
- Website Builder
- Subscriptions
- Marketing Automation
- Agent Skills
url: https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-08-13'
specificationVersion: '0.23'
apis:
- aid: clickfunnels:clickfunnels-addresses-country-api
name: ClickFunnels Addresses::Country API
description: '> Countries are a global reference list used when setting addresses.
The Addresses::Country API provides read-only access to the list of countries, each with its ISO 3166-1 alpha-2 code (iso2).
Use a country''s iso2 as the country_code when setting an address, and as the {country_id} path segment when listing its
regions.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Addresses::Country
properties:
- type: OpenAPI
url: openapi/clickfunnels-addresses-country-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-addresses-region-api
name: ClickFunnels Addresses::Region API
description: '> Regions are the states/provinces of a country.
The Addresses::Region API provides read-only access to the regions of a country. Use a region''s code or name as the address
region value. Many countries have no regions.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Addresses::Region
properties:
- type: OpenAPI
url: openapi/clickfunnels-addresses-region-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-appointments-scheduledevent-api
name: ClickFunnels Appointments::Scheduled Event API
description: '> Scheduled Appointment Events represent set meeting events
The Appointment Scheduled Event represents a scheduled meeting between a ClickFunnels user and a contact on a specific
day and time.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Appointments::ScheduledEvent
properties:
- type: OpenAPI
url: openapi/clickfunnels-appointments-scheduledevent-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-blog-api
name: ClickFunnels Blog API
description: '> Blogs represent a blog resource belonging to a workspace site
A Blog is a top-level container for blog posts, categories, tags, and authors. Each workspace site can have one or more
blogs, each with their own SEO settings, theme, and URL path.
See the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md) for the end-to-end guide to creating,
reading, and updating blog posts.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Blog
properties:
- type: OpenAPI
url: openapi/clickfunnels-blog-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-blogs-author-api
name: ClickFunnels Blogs::Author API
description: Blog Authors. See [Authors (read-only)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#authors-read-only)
in the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md).
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Blogs::Author
properties:
- type: OpenAPI
url: openapi/clickfunnels-blogs-author-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-blogs-category-api
name: ClickFunnels Blogs::Category API
description: Blog Categories. See [Categories (read-only)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#categories-read-only)
in the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md).
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Blogs::Category
properties:
- type: OpenAPI
url: openapi/clickfunnels-blogs-category-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-blogs-post-api
name: ClickFunnels Blogs::Post API
description: '> Blog Posts are the individual articles published within a Blog
Blog posts support rich content via PML markup, visibility controls, SEO settings, categories, tags, and authors. Use
`expand[]=markup` to retrieve the PML markup for a post''s visual content.
See [Creating a blog post](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#creating-a-blog-post) in the
[Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md); the `markup` body is authored in PML —
see the [Page Markup Skill](https://accounts.myclickfunnels.com/.well-known/page-markup/skill.md).
To copy posts in from an external RSS/Atom feed or article page, see the [Import External Blog Post Skill](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md),
which covers [normalizing external HTML for PML](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#3-normalize-external-html-for-pml),
[duplicate checking](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#4-discover-the-destination-and-check-for-duplicates),
and [verifying the draft](https://accounts.myclickfunnels.com/.well-known/blogs/import-external-post/skill.md#6-verify-the-draft)
before publishing.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Blogs::Post
properties:
- type: OpenAPI
url: openapi/clickfunnels-blogs-post-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-blogs-tag-api
name: ClickFunnels Blogs::Tag API
description: Blog Tags. See [Tags (list / show / create)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#tags-list--show--create)
in the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md).
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Blogs::Tag
properties:
- type: OpenAPI
url: openapi/clickfunnels-blogs-tag-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-ban-api
name: ClickFunnels Communities::Ban API
description: '> Bans prevent a Contact from accessing a Community.
A Ban records which Contact is banned, who issued the ban, the scope of the ban (`bannable_type`/`bannable_id`), and an
optional reason. The `banned_by` moderator is set automatically to the acting user — it cannot be set in the request body.
Bans have no update operation — delete and recreate to change the reason.
See also: `Communities::Bans::UnbanAction` and `Communities::Bans::ExportAction` for async bulk operations on bans.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Ban
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-ban-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-bans-exportaction-api
name: ClickFunnels Communities::Bans::Export Action API
description: '> Async bulk action that exports community ban data to a file in the background.
Creating an ExportAction enqueues a background job and immediately returns an action record. Poll the `show` endpoint
using the returned `id` and check the `status` field (`queued` → `processing` → `completed`) to track progress. Use the
`index` endpoint to list previous export actions for a community.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Bans::ExportAction
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-bans-exportaction-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-bans-unbanaction-api
name: ClickFunnels Communities::Bans::Unban Action API
description: '> Async bulk action that unbans multiple contacts from a community in the background.
Creating an UnbanAction enqueues a background job and immediately returns an action record. Poll the `show` endpoint using
the returned `id` and check the `status` field (`queued` → `processing` → `completed`) to track progress.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Bans::UnbanAction
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-bans-unbanaction-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-membership-api
name: ClickFunnels Communities::Membership API
description: '> Memberships represent a Contact''s membership in a Community.
A Membership joins a Contact to a Community and tracks whether that member has moderator privileges. Creating or updating
a membership also syncs the member''s Space memberships to exactly the list of `space_ids` supplied. Deleting a membership
removes the contact from all Spaces in the community as well.
See also: `Communities::Memberships::BanAction`, `Communities::Memberships::AddToGroupAction`, `Communities::Memberships::RemoveFromGroupAction`,
and `Communities::Memberships::ExportAction` for async bulk operations on memberships.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Membership
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-membership-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-memberships-addtogroupaction-api
name: ClickFunnels Communities::Memberships::Add To Group Action API
description: '> Async bulk action that adds multiple members to one or more community spaces (groups) in the background.
Creating an AddToGroupAction enqueues a background job and immediately returns an action record. Poll the `show` endpoint
using the returned `id` and check the `status` field (`queued` → `processing` → `completed`) to track progress.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Memberships::AddToGroupAction
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-memberships-addtogroupaction-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-memberships-banaction-api
name: ClickFunnels Communities::Memberships::Ban Action API
description: '> Async bulk action that bans multiple community members in the background.
Creating a BanAction enqueues a background job and immediately returns an action record. Poll the `show` endpoint using
the returned `id` and check the `status` field (`queued` → `processing` → `completed`) to track progress.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Memberships::BanAction
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-memberships-banaction-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-memberships-exportaction-api
name: ClickFunnels Communities::Memberships::Export Action API
description: '> Async bulk action that exports community membership data to a file in the background.
Creating an ExportAction enqueues a background job and immediately returns an action record. Poll the `show` endpoint
using the returned `id` and check the `status` field (`queued` → `processing` → `completed`) to track progress. Use the
`index` endpoint to list previous export actions for a community.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Memberships::ExportAction
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-memberships-exportaction-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-memberships-removefromgroupaction-api
name: ClickFunnels Communities::Memberships::Remove From Group Action API
description: '> Async bulk action that removes multiple members from one or more community spaces (groups) in the background.
Creating a RemoveFromGroupAction enqueues a background job and immediately returns an action record. Poll the `show` endpoint
using the returned `id` and check the `status` field (`queued` → `processing` → `completed`) to track progress.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Memberships::RemoveFromGroupAction
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-memberships-removefromgroupaction-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-space-api
name: ClickFunnels Communities::Space API
description: '> Spaces (Topics) are the individual discussion areas within a Space Group.
A Space is a single discussion channel or topic area within a Space Group. Members post, comment, and interact inside
Spaces. Each Space can be configured with its own layout, access controls, sorting, and SEO settings.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Space
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-space-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-spacegroup-api
name: ClickFunnels Communities::Space Group API
description: '> Space Groups are named sections within a Community that contain Spaces (Topics).
A Space Group is a logical grouping of Spaces (Topics) within a Community. Use Space Groups to organize community content
into sections. Each Space Group can have its own access level, post/comment approval settings, and visibility controls.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::SpaceGroup
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-spacegroup-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-spaces-post-api
name: ClickFunnels Communities::Spaces::Post API
description: '> Posts are member-created content items within a Community Space.
A Post belongs to a Space and is authored by a Contact. Posts support rich HTML body content, optional titles, pinning,
and cover images. Posts created via the API are auto-approved. Use `Communities::Spaces::Post::Comment`, `Communities::Spaces::Post::Like`,
and `Communities::Spaces::Post::VideoEmbed` to manage the sub-resources of a post.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Spaces::Post
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-spaces-post-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-spaces-post-comment-api
name: ClickFunnels Communities::Spaces::Post::Comment API
description: '> Comments are member replies on a Community Post.
A Comment belongs to a Post and is authored by a Contact. Comments support rich HTML body content and threaded replies
via `parent_comment_id`. Comments created via the API are auto-approved.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Spaces::Post::Comment
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-spaces-post-comment-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-spaces-post-comment-like-api
name: ClickFunnels Communities::Spaces::Post::Comment::Like API
description: '> Comment Likes record a Contact''s like reaction on a Post Comment.
A Comment Like belongs to a Comment and is authored by a Contact. Likes have no update operation — create one to like,
delete it to unlike.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Spaces::Post::Comment::Like
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-spaces-post-comment-like-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-spaces-post-like-api
name: ClickFunnels Communities::Spaces::Post::Like API
description: '> Post Likes record a Contact''s like reaction on a Community Post.
A Post Like belongs to a Post and is authored by a Contact. Likes have no update operation — create one to like, delete
it to unlike.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Spaces::Post::Like
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-spaces-post-like-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-communities-spaces-post-videoembed-api
name: ClickFunnels Communities::Spaces::Post::Video Embed API
description: '> Video Embeds attach a hosted video to a Community Post.
A Video Embed belongs to a Post and stores the provider name, source URL, and optional provider-specific metadata. Video
Embeds have no update operation.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Communities::Spaces::Post::VideoEmbed
properties:
- type: OpenAPI
url: openapi/clickfunnels-communities-spaces-post-videoembed-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-community-api
name: ClickFunnels Community API
description: '> Communities are membership-based spaces where contacts can post, interact, and engage.
A Community is the top-level container for community content. It belongs to a workspace site and holds one or more Space
Groups, each of which contains Spaces (Topics). Use the `Communities::SpaceGroup` and `Communities::Space` resources to
manage the groups and topics within a community.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Community
properties:
- type: OpenAPI
url: openapi/clickfunnels-community-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-contact-api
name: ClickFunnels Contact API
description: Contact
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myclickfunnels.com/api/v2
tags:
- Contact
properties:
- type: OpenAPI
url: openapi/clickfunnels-contact-api-openapi.yml
- type: Documentation
url: https://developers.myclickfunnels.com/docs/intro
- type: APIReference
url: https://developers.myclickfunnels.com/reference
- type: GettingStarted
url: https://developers.myclickfunnels.com/docs/getting-started
- type: DataModel
url: data-model/clickfunnels-data-model.yml
- type: ErrorCatalog
url: errors/clickfunnels-problem-types.yml
- type: RateLimits
url: rate-limits/clickfunnels-rate-limits.yml
- aid: clickfunnels:clickfunnels-contacts-appliedtag-api
name: ClickFunnels Contacts::Applied Tag API
description: '> Contact Applied Tags
The Contact Applied Tags APIs allow you to list, apply and remove tags associated with a specific contact.
To utilize this, first obtain the Tag IDs for all the Contact Tags for your workspace via the Contacts::Tags API.
You can manage tags for any contact by creating or deleting the corresponding Applied Tags as needed.
Note:
There is no ''update'' method for this API since you should just remove and add a new tag to change them.'
humanURL: https://developers.myclickfunnels.com/reference
baseURL: https://{subdomain}.myc
# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clickfunnels/refs/heads/main/apis.yml
Every provider here is available over the APIs.io API and to AI agents over MCP.
Kin Score
How this is scored →