Documents API: List document versions

Endpoint#

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

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
document_id	id primitive (encoded as string)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
versions	array of document_version object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/documents/list_document_versions?document_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "versions": [
    {
      "__typename": "value",
      "content": "value",
      "content_changed": true,
      "editor": "<person>",
      "id": "value",
      "inserted_at": "value",
      "is_current": true,
      "origin": "value",
      "restored_from_version_number": 123,
      "title": "value",
      "title_changed": true,
      "version_number": 123
    }
  ]
}