openapi: 3.2.0 info: title: ClickFunnels Communities::Space 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: Communities::Space 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. ' paths: /communities/space_groups/{space_group_id}/spaces: get: tags: - Communities::Space summary: List Spaces description: List spaces within a space group operationId: listCommunitiesSpaces parameters: - name: space_group_id in: path required: true schema: type: string - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' - $ref: '#/components/parameters/sort_property' 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/CommunitiesSpaceAttributes' example: - id: 1 public_id: CdEfGh space_group_id: 1 workspace_id: 42 name: Welcome access: 0 current_path: /welcome emoji: 👋 card_image_id: null social_image_id: null members_can_post: true members_can_invite: null allow_post_titles: null allow_cover_images: null hide_from_featured: null layout_style: null default_tab: null default_post_sort: null default_comment_sort: null default_member_sort: null pinned_posts_label: null seo_title: null seo_description: null sort_order: 1 always_on: null upgrade_url: null created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' - id: 2 public_id: IjKlMn space_group_id: 1 workspace_id: 42 name: Introductions access: 0 current_path: /introductions emoji: 🙌 card_image_id: null social_image_id: null members_can_post: true members_can_invite: null allow_post_titles: null allow_cover_images: null hide_from_featured: null layout_style: null default_tab: null default_post_sort: null default_comment_sort: null default_member_sort: null pinned_posts_label: null seo_title: null seo_description: null sort_order: 2 always_on: null upgrade_url: null created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '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 Space Group parent ID. example: error: 'Not found: Record missing' post: tags: - Communities::Space summary: Create Space description: Create a space within a space group operationId: createCommunitiesSpaces parameters: - name: space_group_id in: path required: true schema: type: string requestBody: description: Information about a new Space required: true content: application/json: schema: type: object properties: communities_space: type: object $ref: '#/components/schemas/CommunitiesSpaceParameters' example: communities_space: name: Welcome responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpaceAttributes' example: id: 3 public_id: OpQrSt space_group_id: 1 workspace_id: 42 name: Welcome access: 0 current_path: null emoji: null card_image_id: null social_image_id: null members_can_post: true members_can_invite: null allow_post_titles: null allow_cover_images: null hide_from_featured: null layout_style: null default_tab: null default_post_sort: null default_comment_sort: null default_member_sort: null pinned_posts_label: null seo_title: null seo_description: null sort_order: null always_on: null upgrade_url: null created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '422': description: Unprocessable Entity content: application/json: schema: type: object properties: error: type: string example: error: Name can't be blank /communities/spaces/{id}: get: tags: - Communities::Space summary: Fetch Space description: Retrieve a space operationId: getCommunitiesSpaces parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpaceAttributes' example: id: 1 public_id: CdEfGh space_group_id: 1 workspace_id: 42 name: Welcome access: 0 current_path: /welcome emoji: 👋 card_image_id: null social_image_id: null members_can_post: true members_can_invite: null allow_post_titles: null allow_cover_images: null hide_from_featured: null layout_style: null default_tab: null default_post_sort: null default_comment_sort: null default_member_sort: null pinned_posts_label: null seo_title: null seo_description: null sort_order: 1 always_on: null upgrade_url: null created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '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 example: error: 'Not found: Record missing' put: tags: - Communities::Space summary: Update Space description: Update a space operationId: updateCommunitiesSpaces parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Space required: true content: application/json: schema: type: object properties: communities_space: type: object $ref: '#/components/schemas/CommunitiesSpaceParametersUpdate' example: communities_space: name: Welcome access: 0 members_can_post: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommunitiesSpaceAttributes' example: id: 1 public_id: CdEfGh space_group_id: 1 workspace_id: 42 name: Welcome access: 0 current_path: /welcome emoji: 👋 card_image_id: null social_image_id: null members_can_post: true members_can_invite: null allow_post_titles: null allow_cover_images: null hide_from_featured: null layout_style: null default_tab: null default_post_sort: null default_comment_sort: null default_member_sort: null pinned_posts_label: null seo_title: null seo_description: null sort_order: 1 always_on: null upgrade_url: null created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '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 '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' delete: tags: - Communities::Space summary: Remove Space description: Delete a space operationId: removeCommunitiesSpaces parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '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 example: error: 'Not found: Record missing' components: schemas: CommunitiesSpaceParametersUpdate: type: object title: Communities::Space description: Communities::Space properties: name: type: - string - 'null' description: Name access: type: - integer - 'null' description: Access level (0 = open, 1 = private, 2 = secret) current_path: type: - string - 'null' description: Current Path emoji: type: - string - 'null' description: Emoji icon for the space card_image_id: type: - integer - 'null' description: Card Image ID social_image_id: type: - integer - 'null' description: Social Image ID members_can_post: type: - boolean - 'null' description: Whether members can post in this space members_can_invite: type: - boolean - 'null' description: Whether members can invite others to this space allow_post_titles: type: - boolean - 'null' description: Whether posts can have titles allow_cover_images: type: - boolean - 'null' description: Whether posts can have cover images hide_from_featured: type: - boolean - 'null' description: Whether to hide this space from the featured spaces list layout_style: type: - string - 'null' description: Layout style for the space default_tab: type: - string - 'null' description: Default tab shown when viewing the space default_post_sort: type: - string - 'null' description: Default sort order for posts default_comment_sort: type: - string - 'null' description: Default sort order for comments default_member_sort: type: - string - 'null' description: Default sort order for members pinned_posts_label: type: - string - 'null' description: Label for pinned posts section seo_title: type: - string - 'null' description: Seo Title seo_description: type: - string - 'null' description: Seo Description sort_order: type: - integer - 'null' description: Sort order within the space group always_on: type: - boolean - 'null' description: Always On upgrade_url: type: - string - 'null' description: Upgrade URL example: communities_space: name: Welcome access: 0 members_can_post: true CommunitiesSpaceAttributes: type: object title: Communities::Space description: Communities::Space properties: id: type: integer description: Space ID public_id: type: - string - 'null' description: Space public ID space_group_id: type: integer description: Space Group ID the space belongs to workspace_id: type: integer description: Workspace ID the space belongs to name: type: - string - 'null' description: Name access: type: string enum: - is_open - is_private - is_secret description: Access level current_path: type: - string - 'null' description: Current Path emoji: type: - string - 'null' description: Emoji icon for the space card_image_id: type: - integer - 'null' description: Card Image ID social_image_id: type: - integer - 'null' description: Social Image ID members_can_post: type: boolean description: Whether members can post in this space members_can_invite: type: - boolean - 'null' description: Whether members can invite others to this space allow_post_titles: type: - boolean - 'null' description: Whether posts can have titles allow_cover_images: type: - boolean - 'null' description: Whether posts can have cover images hide_from_featured: type: - boolean - 'null' description: Whether to hide this space from the featured spaces list layout_style: type: - string - 'null' description: Layout style for the space default_tab: type: - string - 'null' description: Default tab shown when viewing the space default_post_sort: type: - string - 'null' description: Default sort order for posts default_comment_sort: type: - string - 'null' description: Default sort order for comments default_member_sort: type: - string - 'null' description: Default sort order for members pinned_posts_label: type: - string - 'null' description: Label for pinned posts section seo_title: type: - string - 'null' description: Seo Title seo_description: type: - string - 'null' description: Seo Description sort_order: type: - integer - 'null' description: Sort order within the space group always_on: type: - boolean - 'null' description: Always On upgrade_url: type: - string - 'null' description: Upgrade URL created_at: type: - string - 'null' format: date-time description: Created at updated_at: type: - string - 'null' format: date-time description: Updated at example: id: 1 public_id: CdEfGh space_group_id: 1 workspace_id: 42 name: Welcome access: is_open current_path: /welcome emoji: 👋 card_image_id: null social_image_id: null members_can_post: true members_can_invite: null allow_post_titles: null allow_cover_images: null hide_from_featured: null layout_style: null default_tab: null default_post_sort: null default_comment_sort: null default_member_sort: null pinned_posts_label: null seo_title: null seo_description: null sort_order: 1 always_on: null upgrade_url: null created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' required: - access - allow_cover_images - allow_post_titles - always_on - card_image_id - created_at - current_path - default_comment_sort - default_member_sort - default_post_sort - default_tab - emoji - hide_from_featured - id - layout_style - members_can_invite - members_can_post - name - pinned_posts_label - public_id - seo_description - seo_title - social_image_id - sort_order - space_group_id - updated_at - upgrade_url - workspace_id CommunitiesSpaceParameters: type: object title: Communities::Space description: Communities::Space required: - name properties: name: type: string description: Name access: type: - integer - 'null' description: Access level (0 = open, 1 = private, 2 = secret) current_path: type: - string - 'null' description: Current Path emoji: type: - string - 'null' description: Emoji icon for the space card_image_id: type: - integer - 'null' description: Card Image ID social_image_id: type: - integer - 'null' description: Social Image ID members_can_post: type: - boolean - 'null' description: Whether members can post in this space members_can_invite: type: - boolean - 'null' description: Whether members can invite others to this space allow_post_titles: type: - boolean - 'null' description: Whether posts can have titles allow_cover_images: type: - boolean - 'null' description: Whether posts can have cover images hide_from_featured: type: - boolean - 'null' description: Whether to hide this space from the featured spaces list layout_style: type: - string - 'null' description: Layout style for the space default_tab: type: - string - 'null' description: Default tab shown when viewing the space default_post_sort: type: - string - 'null' description: Default sort order for posts default_comment_sort: type: - string - 'null' description: Default sort order for comments default_member_sort: type: - string - 'null' description: Default sort order for members pinned_posts_label: type: - string - 'null' description: Label for pinned posts section seo_title: type: - string - 'null' description: Seo Title seo_description: type: - string - 'null' description: Seo Description sort_order: type: - integer - 'null' description: Sort order within the space group always_on: type: - boolean - 'null' description: Always On upgrade_url: type: - string - 'null' description: Upgrade URL example: communities_space: name: Welcome parameters: id: name: id in: path required: true schema: type: string sort_property: name: sort_property in: query description: '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. ' required: false schema: type: string enum: - id - updated_at sort_order: name: sort_order in: query description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). required: false schema: type: string enum: - asc - desc after: name: after in: query required: false schema: type: string description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination). headers: Link: description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value. schema: type: string PaginationNext: description: 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. schema: type: string securitySchemes: BearerAuth: type: http scheme: bearer externalDocs: description: More in-depth guides and further resources url: https://developers.myclickfunnels.com