Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Communities::Space

List Spaces

List spaces within a space group

get/communities/space_groups/{space_group_id}/spaces

Path parameters

space_group_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

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

sort_property'id' | 'updated_at'

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.

Response

OK

idinteger

Space ID

public_idstring nullable

Space public ID

space_group_idinteger

Space Group ID the space belongs to

workspace_idinteger

Workspace ID the space belongs to

namestring nullable

Name

access'is_open' | 'is_private' | 'is_secret'

Access level

current_pathstring nullable

Current Path

emojistring nullable

Emoji icon for the space

card_image_idinteger nullable

Card Image ID

social_image_idinteger nullable

Social Image ID

members_can_postboolean

Whether members can post in this space

members_can_inviteboolean nullable

Whether members can invite others to this space

allow_post_titlesboolean nullable

Whether posts can have titles

allow_cover_imagesboolean nullable

Whether posts can have cover images

hide_from_featuredboolean nullable

Whether to hide this space from the featured spaces list

layout_stylestring nullable

Layout style for the space

default_tabstring nullable

Default tab shown when viewing the space

default_post_sortstring nullable

Default sort order for posts

default_comment_sortstring nullable

Default sort order for comments

default_member_sortstring nullable

Default sort order for members

pinned_posts_labelstring nullable

Label for pinned posts section

seo_titlestring nullable

Seo Title

seo_descriptionstring nullable

Seo Description

sort_orderinteger nullable

Sort order within the space group

always_onboolean nullable

Always On

upgrade_urlstring nullable

Upgrade URL

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

Example response

[
  {
    "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"
  }
]