Documents API: List hubs
Endpoint#
Section titled “Endpoint#”| Property | Value |
|---|---|
| Type | query |
| Method | GET |
| Path | /api/external/v1/documents/list_hubs |
| Handler | OperatelyWeb.Api.ResourceHubs.List |
Authentication#
Section titled “Authentication#”- Requires a valid API token.
- Read-only and full-access tokens can execute this query.
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
space_id | id primitive (encoded as string) | Yes | No | - |
Outputs#
Section titled “Outputs#”| Field | Type | Required | Nullable |
|---|---|---|---|
hubs | array of resource_hub_summary object | Yes | No |
cURL Example#
Section titled “cURL Example#”Copied
curl --request GET \
--url "https://app.operately.com/api/external/v1/documents/list_hubs?space_id=value" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}"Response Example#
Section titled “Response Example#”{ "hubs": [ { "__typename": "value", "id": "value", "is_default": true, "name": "value", "position": 123 } ]}