get_spaces

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/get_spaces
Handler	OperatelyWeb.Api.Queries.GetSpaces

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
access_level	access_options enum (no_access, minimal_access, view_access, comment_access, edit_access, admin_access, full_access)	No	No	-
include_access_levels	boolean	No	No	-
include_members	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
spaces	array of space object	No	Yes

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_spaces?access_level=no_access&include_access_levels=true&include_members=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

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