Skip to content

list_resource_hub_nodes

Endpoint#

PropertyValue
Typequery
MethodGET
Path/api/external/v1/list_resource_hub_nodes
HandlerOperatelyWeb.Api.Queries.ListResourceHubNodes

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
resource_hub_idid primitive (encoded as string)NoYes-
folder_idid primitive (encoded as string)NoYes-
include_comments_countbooleanNoYes-
include_children_countbooleanNoYes-

Outputs#

FieldTypeRequiredNullable
nodesarray of resource_hub_node objectNoYes
draft_nodesarray of resource_hub_node objectNoYes

cURL Example#

Copied
curl --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"
    }
  ]
}