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": "2025-06-24T08:51:42.676Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "093c6723-6686-49f4-9cea-064e1c39ec2c",
        "tenantId": "0960c978-8c29-467c-ae8d-a2f577fb3d53",
        "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:

"8587ffc6-4d97-4997-965b-a71bce6e4314"

​
versioningFieldIds
string

Versioning Field IDs (comma separated)

Example:

"75243ca2-9001-49f1-bfb6-3e42db090857, 017ed287-89ac-41c4-8ad2-2a995caf2580"

​
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:

"2025-06-24T08:51:42.676Z"

​
message
string
required
Example:

"Success"

​
data
object