Documents API: Search

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/documents/search
Handler	OperatelyWeb.Api.Wrappers.DocsAndFiles.Search

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
space_id	id primitive (encoded as string)	No	Yes	-
project_id	id primitive (encoded as string)	No	Yes	-
goal_id	id primitive (encoded as string)	No	Yes	-
query	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
nodes	array of resource_hub_node object	Yes	No

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#

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