Skip to main content
GET
/
api
/
projects
/
{projectId}
/
documents
/
{documentId}
/
versions
/
{versionId}
Get a document version
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "content": "<unknown>",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "createdAt": "<string>",
  "versions": [
    "<unknown>"
  ],
  "releases": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
documentId
string<uuid>
required

Document unique identifier

​
projectId
string<uuid>
required

Project unique identifier

​
versionId
string<uuid>
required

Version unique identifier

Response

200 - application/json

Document version with content

Document version with content

​
id
string<uuid>
required

Version unique identifier

​
name
string | null

Version name

​
parentId
string<uuid> | null

Parent version ID for sub-versions

​
status
string

Version status (draft or completed)

​
content
any

Version content data

​
documentId
string<uuid>

Associated document ID

​
createdBy
object

User who created the version

​
createdAt
string

Version creation timestamp

​
versions
any[]

Sub-versions (recursive structure)

​
releases
object[]

Associated releases