openapi: 3.2.0
info:
  title: ClickFunnels Communities::Space Group 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::SpaceGroup
  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.

    '
paths:
  /communities/{community_id}/space_groups:
    get:
      tags:
      - Communities::SpaceGroup
      summary: List Space Groups
      description: List space groups for a community
      operationId: listCommunitiesSpaceGroups
      parameters:
      - name: community_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/CommunitiesSpaceGroupAttributes'
              example:
              - id: 1
                public_id: BcDeFg
                community_id: 1
                workspace_id: 42
                name: General
                description: General discussion group
                access: 0
                group_type: 0
                current_path: /general
                emoji: 💬
                card_image_id: null
                auto_add_to_spaces: false
                approval_terms: null
                require_post_approvals: false
                require_post_approvals_override: false
                require_comment_approvals: false
                require_comment_approvals_override: false
                is_hidden: false
                is_hidden_from_non_members: false
                always_on: null
                upgrade_url: null
                sort_order: 1
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 2
                public_id: HiJkLm
                community_id: 1
                workspace_id: 42
                name: Announcements
                description: Official announcements
                access: 0
                group_type: 0
                current_path: /announcements
                emoji: 📢
                card_image_id: null
                auto_add_to_spaces: true
                approval_terms: null
                require_post_approvals: true
                require_post_approvals_override: false
                require_comment_approvals: false
                require_comment_approvals_override: false
                is_hidden: false
                is_hidden_from_non_members: false
                always_on: null
                upgrade_url: null
                sort_order: 2
                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 Community parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Communities::SpaceGroup
      summary: Create Space Group
      description: Create a space group within a community
      operationId: createCommunitiesSpaceGroups
      parameters:
      - name: community_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Space Group
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                communities_space_group:
                  type: object
                  $ref: '#/components/schemas/CommunitiesSpaceGroupParameters'
            example:
              communities_space_group:
                name: General
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesSpaceGroupAttributes'
              example:
                id: 3
                public_id: NoPqRs
                community_id: 1
                workspace_id: 42
                name: General
                description: null
                access: 0
                group_type: 0
                current_path: null
                emoji: null
                card_image_id: null
                auto_add_to_spaces: false
                approval_terms: null
                require_post_approvals: false
                require_post_approvals_override: false
                require_comment_approvals: false
                require_comment_approvals_override: false
                is_hidden: false
                is_hidden_from_non_members: false
                always_on: null
                upgrade_url: null
                sort_order: 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/space_groups/{id}:
    get:
      tags:
      - Communities::SpaceGroup
      summary: Fetch Space Group
      description: Retrieve a space group
      operationId: getCommunitiesSpaceGroups
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesSpaceGroupAttributes'
              example:
                id: 1
                public_id: BcDeFg
                community_id: 1
                workspace_id: 42
                name: General
                description: General discussion group
                access: 0
                group_type: 0
                current_path: /general
                emoji: 💬
                card_image_id: null
                auto_add_to_spaces: false
                approval_terms: null
                require_post_approvals: false
                require_post_approvals_override: false
                require_comment_approvals: false
                require_comment_approvals_override: false
                is_hidden: false
                is_hidden_from_non_members: false
                always_on: null
                upgrade_url: null
                sort_order: 1
                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::SpaceGroup
      summary: Update Space Group
      description: Update a space group
      operationId: updateCommunitiesSpaceGroups
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Space Group
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                communities_space_group:
                  type: object
                  $ref: '#/components/schemas/CommunitiesSpaceGroupParametersUpdate'
            example:
              communities_space_group:
                name: General
                access: 0
                is_hidden: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesSpaceGroupAttributes'
              example:
                id: 1
                public_id: BcDeFg
                community_id: 1
                workspace_id: 42
                name: General
                description: General discussion group
                access: 0
                group_type: 0
                current_path: /general
                emoji: 💬
                card_image_id: null
                auto_add_to_spaces: false
                approval_terms: null
                require_post_approvals: false
                require_post_approvals_override: false
                require_comment_approvals: false
                require_comment_approvals_override: false
                is_hidden: false
                is_hidden_from_non_members: false
                always_on: null
                upgrade_url: null
                sort_order: 1
                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::SpaceGroup
      summary: Remove Space Group
      description: Delete a space group
      operationId: removeCommunitiesSpaceGroups
      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:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    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).
    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
  schemas:
    CommunitiesSpaceGroupAttributes:
      type: object
      title: Communities::SpaceGroup
      description: Communities::SpaceGroup
      properties:
        id:
          type: integer
          description: Group ID
        public_id:
          type:
          - string
          - 'null'
          description: Group public ID
        community_id:
          type: integer
          description: Community ID the space group belongs to
        workspace_id:
          type: integer
          description: Workspace ID the space group belongs to
        name:
          type:
          - string
          - 'null'
          description: Name
        description:
          type:
          - string
          - 'null'
          description: Description
        access:
          type: string
          enum:
          - is_open
          - is_private
          - is_secret
          description: Access level
        group_type:
          type: string
          enum:
          - standard
          - course
          description: Group type
        current_path:
          type:
          - string
          - 'null'
          description: Current Path
        emoji:
          type:
          - string
          - 'null'
          description: Emoji icon for the group
        card_image_id:
          type:
          - integer
          - 'null'
          description: Card Image ID
        auto_add_to_spaces:
          type: boolean
          description: Automatically add members to new Topics within this Group
        approval_terms:
          type:
          - string
          - 'null'
          description: Approval Terms — if present, these terms are used to AI moderate posts and comments automatically
        require_post_approvals:
          type:
          - boolean
          - 'null'
          description: Require approvals for posts in this Group?
        require_post_approvals_override:
          type:
          - boolean
          - 'null'
          description: Whether the group-level post approval setting overrides the community-level setting
        require_comment_approvals:
          type:
          - boolean
          - 'null'
          description: Require approvals for comments in this Group?
        require_comment_approvals_override:
          type:
          - boolean
          - 'null'
          description: Whether the group-level comment approval setting overrides the community-level setting
        is_hidden:
          type: boolean
          description: Only show joined Topics — when enabled customers only see Topics in the sidebar they have joined
        is_hidden_from_non_members:
          type: boolean
          description: Hide from non-members — when enabled the group is not visible unless the customer belongs to one of its Topics
        always_on:
          type:
          - boolean
          - 'null'
          description: Always On
        upgrade_url:
          type:
          - string
          - 'null'
          description: Upgrade URL — directs non-customers to an action page to gain access to this group
        sort_order:
          type:
          - integer
          - 'null'
          description: Sort order within the community
        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: BcDeFg
        community_id: 1
        workspace_id: 42
        name: General
        description: General discussion group
        access: is_open
        group_type: standard
        current_path: /general
        emoji: 💬
        card_image_id: null
        auto_add_to_spaces: false
        approval_terms: null
        require_post_approvals: false
        require_post_approvals_override: false
        require_comment_approvals: false
        require_comment_approvals_override: false
        is_hidden: false
        is_hidden_from_non_members: false
        always_on: null
        upgrade_url: null
        sort_order: 1
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - access
      - always_on
      - approval_terms
      - auto_add_to_spaces
      - card_image_id
      - community_id
      - created_at
      - current_path
      - description
      - emoji
      - group_type
      - id
      - is_hidden
      - is_hidden_from_non_members
      - name
      - public_id
      - require_comment_approvals
      - require_comment_approvals_override
      - require_post_approvals
      - require_post_approvals_override
      - sort_order
      - updated_at
      - upgrade_url
      - workspace_id
    CommunitiesSpaceGroupParameters:
      type: object
      title: Communities::SpaceGroup
      description: Communities::SpaceGroup
      required:
      - name
      properties:
        name:
          type: string
          description: Name
        description:
          type:
          - string
          - 'null'
          description: Description
        access:
          type:
          - integer
          - 'null'
          description: Access level (0 = open, 1 = private, 2 = secret)
        group_type:
          type:
          - integer
          - 'null'
          description: Group type (integer enum)
        current_path:
          type:
          - string
          - 'null'
          description: Current Path
        emoji:
          type:
          - string
          - 'null'
          description: Emoji icon for the group
        card_image_id:
          type:
          - integer
          - 'null'
          description: Card Image ID
        auto_add_to_spaces:
          type:
          - boolean
          - 'null'
          description: Automatically add members to new Topics within this Group
        approval_terms:
          type:
          - string
          - 'null'
          description: Approval Terms
        require_post_approvals:
          type:
          - boolean
          - 'null'
          description: Require approvals for posts in this Group?
        require_post_approvals_override:
          type:
          - boolean
          - 'null'
          description: Override community-level post approval setting for this group
        require_comment_approvals:
          type:
          - boolean
          - 'null'
          description: Require approvals for comments in this Group?
        require_comment_approvals_override:
          type:
          - boolean
          - 'null'
          description: Override community-level comment approval setting for this group
        is_hidden:
          type:
          - boolean
          - 'null'
          description: Only show joined Topics
        is_hidden_from_non_members:
          type:
          - boolean
          - 'null'
          description: Hide from non-members
        always_on:
          type:
          - boolean
          - 'null'
          description: Always On
        upgrade_url:
          type:
          - string
          - 'null'
          description: Upgrade URL
        sort_order:
          type:
          - integer
          - 'null'
          description: Sort order within the community
      example:
        communities_space_group:
          name: General
    CommunitiesSpaceGroupParametersUpdate:
      type: object
      title: Communities::SpaceGroup
      description: Communities::SpaceGroup
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name
        description:
          type:
          - string
          - 'null'
          description: Description
        access:
          type:
          - integer
          - 'null'
          description: Access level (0 = open, 1 = private, 2 = secret)
        group_type:
          type:
          - integer
          - 'null'
          description: Group type (integer enum)
        current_path:
          type:
          - string
          - 'null'
          description: Current Path
        emoji:
          type:
          - string
          - 'null'
          description: Emoji icon for the group
        card_image_id:
          type:
          - integer
          - 'null'
          description: Card Image ID
        auto_add_to_spaces:
          type:
          - boolean
          - 'null'
          description: Automatically add members to new Topics within this Group
        approval_terms:
          type:
          - string
          - 'null'
          description: Approval Terms
        require_post_approvals:
          type:
          - boolean
          - 'null'
          description: Require approvals for posts in this Group?
        require_post_approvals_override:
          type:
          - boolean
          - 'null'
          description: Override community-level post approval setting for this group
        require_comment_approvals:
          type:
          - boolean
          - 'null'
          description: Require approvals for comments in this Group?
        require_comment_approvals_override:
          type:
          - boolean
          - 'null'
          description: Override community-level comment approval setting for this group
        is_hidden:
          type:
          - boolean
          - 'null'
          description: Only show joined Topics
        is_hidden_from_non_members:
          type:
          - boolean
          - 'null'
          description: Hide from non-members
        always_on:
          type:
          - boolean
          - 'null'
          description: Always On
        upgrade_url:
          type:
          - string
          - 'null'
          description: Upgrade URL
        sort_order:
          type:
          - integer
          - 'null'
          description: Sort order within the community
      example:
        communities_space_group:
          name: General
          access: 0
          is_hidden: false
  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