Documents API: Get document

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/documents/get_document
Handler	OperatelyWeb.Api.Documents.Get

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
id	id primitive (encoded as string)	Yes	No	-
include_author	boolean	No	Yes	-
include_space	boolean	No	Yes	-
include_project	boolean	No	Yes	-
include_goal	boolean	No	Yes	-
include_resource_hub	boolean	No	Yes	-
include_parent_folder	boolean	No	Yes	-
include_reactions	boolean	No	Yes	-
include_permissions	boolean	No	Yes	-
include_subscriptions_list	boolean	No	Yes	-
include_potential_subscribers	boolean	No	Yes	-
include_unread_notifications	boolean	No	Yes	-
include_path_to_document	boolean	No	Yes	-
include_versions_count	boolean	No	Yes	-

Outputs#

Field	Type	Required	Nullable
document	resource_hub_document object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/documents/get_document?id=value&include_author=true&include_goal=true&include_parent_folder=true&include_path_to_document=true&include_permissions=true&include_potential_subscribers=true&include_project=true&include_reactions=true&include_resource_hub=true&include_space=true&include_subscriptions_list=true&include_unread_notifications=true&include_versions_count=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "document": {
    "__typename": "value",
    "author": "<person>",
    "comments_count": 123,
    "content": "value",
    "current_version": 123,
    "goal": "<goal>",
    "id": "value",
    "inserted_at": "value",
    "name": "value",
    "notifications": [
      "<notification>"
    ],
    "parent_folder": "<resource_hub_folder>",
    "parent_folder_id": "value",
    "path_to_document": [
      "<resource_hub_folder>"
    ],
    "permissions": "<resource_hub_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "project": "<project>",
    "public_url": "value",
    "published_at": "2026-01-01T09:30:00Z",
    "reactions": [
      "<reaction>"
    ],
    "resource_hub": "<resource_hub>",
    "resource_hub_id": "value",
    "space": "<space>",
    "state": "draft",
    "subscription_list": "<subscription_list>",
    "updated_at": "2026-01-01",
    "url": "value",
    "versions_count": 123
  }
}