Skip to main content
GET
/
items
/
{canonicalId}
/
versions
/
{version}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "itemTypeId": "<string>",
  "number": "<string>",
  "version": 2,
  "current": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attributes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributeDefinitionId": "<string>",
      "version": 2,
      "modifiedAt": "2023-11-07T05:31:56Z",
      "modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ],
  "revision": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
canonicalId
string<uuid>
required

The canonical ID that identifies the item across all versions

​
version
integer
required

The specific version number to retrieve

Required range: x >= 1

Response

Item version details

A specific version of an item with its versioned attribute values

​
id
string<uuid>
required

Unique ID of this specific version

​
canonicalId
string<uuid>
required

Stable ID across all versions

​
itemTypeId
string
required
​
number
string
required
​
version
integer
required

Working draft version number

Required range: x >= 1
​
status
enum<string>
required
Available options:
DRAFT,
REVIEW,
RELEASED,
OBSOLETE
​
current
boolean
required

Whether this is the current (latest) version

​
projectId
string<uuid>
required
​
branchId
string<uuid>
required
​
createdAt
string<date-time>
required
​
createdBy
string<uuid>
required
​
modifiedAt
string<date-time>
required
​
modifiedBy
string<uuid>
required
​
attributes
object[]
required
​
revision
string | null

Released change level (Rev A, Rev B, etc.)