Skip to main content
GET
/
v1
/
document-versioning
Get document versioning fields
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/document-versioning \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:21.243Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "7ec9499f-4348-4582-ae80-f98c01f17ca6",
        "tenantId": "be0e7c2c-9ba9-4a2e-9beb-78076253e3cd",
        "fieldName": "Version Number",
        "fieldType": "string",
        "status": true,
        "isDefault": false,
        "isDeleted": false,
        "createdAt": "2024-01-12T00:00:00.000Z",
        "updatedAt": "2024-01-12T00:00:00.000Z"
      }
    ]
  }
}

Authorizations

ā€‹
Authorization
string
header
required

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

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

ā€‹
tenantId
string
required

Tenant ID

Example:

"ef901b71-0d2f-420d-94e9-d0dcf5584e50"

ā€‹
versioningFieldIds
string

Versioning Field IDs (comma separated)

Example:

"d5f10e4c-c74f-4b62-8a49-550f094ee465, 3cc10295-3e3b-4bd7-b91c-da4632025df6"

ā€‹
search
string

Search by field name

Example:

"Version"

ā€‹
sortBy
string

Field to sort by

Example:

"id"

ā€‹
sortOrder
enum<string>
default:asc

Sort order (asc/desc)

Available options:
asc,
desc
Example:

"asc"

Response

200 - application/json

Document versioning fields list retrieved successfully

ā€‹
statusCode
number
required
Example:

200

ā€‹
timestamp
string
required
Example:

"2026-01-08T06:33:21.243Z"

ā€‹
message
string
required
Example:

"Success"

ā€‹
data
object