Endpoint#
| Property | Value |
|---|
| Type | query |
| Method | GET |
| Path | /api/external/v1/list_resource_hub_nodes |
| Handler | OperatelyWeb.Api.Queries.ListResourceHubNodes |
Authentication#
- Requires a valid API token.
- Read-only and full-access tokens can execute this query.
| Field | Type | Required | Nullable | Default |
|---|
resource_hub_id | id primitive (encoded as string) | No | Yes | - |
folder_id | id primitive (encoded as string) | No | Yes | - |
include_comments_count | boolean | No | Yes | - |
include_children_count | boolean | No | Yes | - |
Outputs#
| Field | Type | Required | Nullable |
|---|
nodes | array of resource_hub_node object | No | Yes |
draft_nodes | array of resource_hub_node object | No | Yes |
cURL Example#
Copiedcurl --request GET \
--url "https://app.operately.com/api/external/v1/list_resource_hub_nodes?folder_id=value&include_children_count=true&include_comments_count=true&resource_hub_id=value" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}"
Response Example#
{
"draft_nodes": [
{
"document": "<resource_hub_document>",
"file": "<resource_hub_file>",
"folder": "<resource_hub_folder>",
"id": "value",
"inserted_at": "value",
"link": "<resource_hub_link>",
"name": "value",
"type": "value",
"updated_at": "value"
}
],
"nodes": [
{
"document": "<resource_hub_document>",
"file": "<resource_hub_file>",
"folder": "<resource_hub_folder>",
"id": "value",
"inserted_at": "value",
"link": "<resource_hub_link>",
"name": "value",
"type": "value",
"updated_at": "value"
}
]
}