Documents API: Search | Operately Help Center Skip to content
Operately Logo Operately Logo Operately Help Center

Documents API: Search

Endpoint#

Section titled “Endpoint#”
PropertyValue
Typequery
MethodGET
Path/api/external/v1/documents/search
HandlerOperatelyWeb.Api.Wrappers.DocsAndFiles.Search

Authentication#

Section titled “Authentication#”
  • Requires a valid API token.
  • Read-only and full-access tokens can execute this query.

Inputs#

Section titled “Inputs#”
FieldTypeRequiredNullableDefault
space_idid primitive (encoded as string)NoYes-
project_idid primitive (encoded as string)NoYes-
goal_idid primitive (encoded as string)NoYes-
querystringYesNo-

Outputs#

Section titled “Outputs#”
FieldTypeRequiredNullable
nodesarray of resource_hub_node objectYesNo

cURL Example#

Section titled “cURL Example#”
Copied
curl --request GET \
  --url "https://app.operately.com/api/external/v1/documents/search?goal_id=value&project_id=value&query=value&space_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

Section titled “Response Example#”
{
  "nodes": [
    {
      "__typename": "value",
      "document": "<resource_hub_document>",
      "file": "<resource_hub_file>",
      "folder": "<resource_hub_folder>",
      "id": "value",
      "inserted_at": "value",
      "link": "<resource_hub_link>",
      "name": "value",
      "path_to_node": [
        "<resource_hub_folder>"
      ],
      "type": "value",
      "updated_at": "value"
    }
  ]
}