Spaces API: Get

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/spaces/get
Handler	OperatelyWeb.Api.Spaces.Get

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
id	id primitive (encoded as string)	Yes	No	-
include_permissions	boolean	No	Yes	-
include_members	boolean	No	Yes	-
include_access_levels	boolean	No	Yes	-
include_members_access_levels	boolean	No	Yes	-
include_potential_subscribers	boolean	No	Yes	-
include_unread_notifications	boolean	No	Yes	-
include_markdown	boolean	No	No	false

Outputs#

Field	Type	Required	Nullable
space	space object	Yes	No
markdown	string	No	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/spaces/get?id=value&include_access_levels=true&include_markdown=true&include_members=true&include_members_access_levels=true&include_permissions=true&include_potential_subscribers=true&include_unread_notifications=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "markdown": "value",
  "space": {
    "__typename": "value",
    "access_levels": "<access_levels>",
    "color": "value",
    "icon": "value",
    "id": "value",
    "is_company_space": true,
    "is_member": true,
    "members": [
      "<person>"
    ],
    "mission": "value",
    "name": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<space_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "private_space": true,
    "task_statuses": [
      "<task_status>"
    ],
    "tasks_kanban_state": "value",
    "url": "value"
  }
}