Skip to main content
GET
/
items
/
{canonicalId}
/
history
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "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>"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123,
  "hasNext": true
}

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

Query Parameters

page
integer
default:0

Page number (0-based)

Required range: x >= 0
pageSize
integer
default:50

Number of items per page

Required range: 1 <= x <= 100

Response

Paginated list of item versions

Paginated response containing item versions

items
object[]
required
total
integer<int64>
required

Total number of versions across all pages

page
integer
required

Current page number (0-based)

pageSize
integer
required

Number of items per page

hasNext
boolean
required

Whether there are more pages available