Skip to main content
GET
/
v1
/
document-types
List document types
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/document-types \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:42.620Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "18734e63-f5ee-44ba-95e3-14e5e773d9e0",
        "tenantId": "58e1ecd8-43ec-4ef0-ba29-aa04535beca6",
        "typeName": "Invoice",
        "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:

"a5b50588-c7f7-4ff3-9702-cf6c4aa2fd22"

​
documentTypeIds
string

Document Type IDs (comma separated)

Example:

"18abc73f-07a0-4c4b-a946-9b197de92fb1, d2aff11e-f2b6-4613-af6e-437d1a4730eb"

​
search
string

Search by type name

Example:

"Invoice"

​
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 types list retrieved successfully

​
statusCode
number
required
Example:

200

​
timestamp
string
required
Example:

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

​
message
string
required
Example:

"Success"

​
data
object