Get document changelog

GET /v1/documents/{id}/changelog

Get document changelog

cURL

curl --request GET \
  --url https://staging.api.us.aptlydone.com/document/v1/documents/{id}/changelog \
  --header 'Authorization: Bearer <token>'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:12:24.385Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
        "tenantId": "105fa115-52d0-4466-baff-740447a60774",
        "documentId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
        "revisionId": "123456",
        "revisionDate": "2024-12-18T09:50:43.338Z",
        "revisedById": "105fa115-52d0-4466-baff-740447a60774",
        "revisedByName": "John Doe",
        "revisedUserDetail": {}
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Query Parameters

page · number

Page number

Required range: x >= 1

Example:

1

limit · number

Number of items per page

Required range: 1 <= x <= 100

Example:

10

sortBy · enum<string>

Criteria for sorting Document Changelog

Available options: revisionId, revisionDate

Example:

"documentName"

sortOrder · enum<string>

Order for sorting Document Changelog

Available options: asc, desc

Example:

"asc"

Response

200 - application/json

Document changelog retrieved successfully

statusCode · number · required

Example:

200

timestamp · string · required

Example:

"2026-01-12T09:12:24.385Z"

message · string · required

Example:

"Success"

data · object

Show child attributes