Skip to main content
GET
/
v1
/
documents
List documents
curl --request GET \
  --url https://staging.api.us.aptlydone.com/document/v1/documents \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:01.606Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440100",
        "tenantId": "550e8400-e29b-41d4-a716-446655440000",
        "documentName": "Global Delegation of Authority Policy - ProxyComm Inc.",
        "documentDescription": "Defines the framework for delegating authority across ProxyComm's global operations, outlining roles, responsibilities, and decision-making limits to ensure compliance, accountability, and operational consistency.",
        "documentMetadata": "{ \"code\": \"GOV-DFA-2\", \"version\": \"2024.2\" }",
        "fileId": "550e8400-e29b-41d4-a716-446655440001",
        "documentTypeId": "550e8400-e29b-41d4-a716-446655440002",
        "documentStatus": "DRAFT",
        "documentSharingType": "RESTRICTED",
        "documentIcon": "link-outlined",
        "documentOwnerId": "550e8400-e29b-41d4-a716-446655440003",
        "documentUploadType": "LINKED",
        "documentUrl": "intranet.sharepoint.proxycomm.com/2024delegationofauthority.policy",
        "uploadedOn": "2025-02-13T12:00:00Z",
        "lastUpdatedBy": "550e8400-e29b-41d4-a716-446655440004",
        "lastUpdatedOn": "2025-02-14T15:30:00Z",
        "archivedOn": "2025-03-01T10:00:00Z",
        "deletedOn": "2025-04-01T12:00:00Z",
        "documentDisplayId": "10000",
        "link": "/documents/view/eyJ0ZW5hbnRJZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsImRvY3VtZW50SWQiOiJjMDBjMGNkNy03ZmJjLTRmZTEtOWYxMy1lYzc5OTlmMjhjNDgifQ==",
        "documentId": "550e8400-e29b-41d4-a716-446655440100",
        "documentTypeName": "Policy",
        "documentOwnerUsername": "John Doe",
        "decisionsCount": 0,
        "delegationsCount": 0,
        "oversightStatuses": [
          "REVIEW_PENDING",
          "APPROVAL_PENDING"
        ],
        "permissions": [
          {
            "relationship_key": "<string>",
            "allowed": true
          }
        ],
        "isReviewerEnable": true,
        "isApprovalEnable": true,
        "isApprovalActionExist": true,
        "isReviewerActionExist": true,
        "isApprovalUser": true,
        "isReviewerUser": true,
        "isSettingApprovalActionEnabled": true,
        "isSettingReviewerActionEnabled": true,
        "reviewerUserProfileUrl": "http://test.jpg",
        "responsibleUserProfileUrl": "http://test.jpg",
        "approverUserProfileUrl": "http://test.jpg",
        "documentOwnerProfileUrl": "http://test.jpg",
        "responsiblePositionId": "550e8400-e29b-41d4-a716-446655440004",
        "responsiblePositionName": "Sr. Corporate Counsel",
        "responsibleUserId": "550e8400-e29b-41d4-a716-446655440002",
        "responsibleUsername": "John Doe",
        "reviewerUserId": "550e8400-e29b-41d4-a716-446655440003",
        "reviewerUsername": "John Doe",
        "reviewerPositionId": "550e8400-e29b-41d4-a716-446655440004",
        "reviewerPositionName": "Sr. Corporate Counsel",
        "approverUserId": "550e8400-e29b-41d4-a716-446655440005",
        "approverUsername": "John Doe",
        "approverPositionId": "550e8400-e29b-41d4-a716-446655440006",
        "approverPositionName": "Sr. Corporate Counsel"
      }
    ]
  }
}

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:

"728dbeef-1fdd-4c15-bd10-8da914882d38"

​
status
enum<string>[]

Comma separated Document Status values

Available options:
DRAFT,
PUBLISHED,
ARCHIVED,
DELETED
​
search
string

Document search string

Example:

""

​
documentType
string[]

Comma separated Document Type IDs

Example:

null

​
oversight
enum<string>[]

Comma separated Oversight Status values

Available options:
REVIEW_PENDING,
REVIEWED,
APPROVAL_PENDING,
APPROVED,
REJECTED
​
documentSharingType
enum<string>[]

Comma separated Document Sharing Type values

Available options:
PUBLIC,
RESTRICTED,
SHARED
​
documentOwnerId
string[]

Comma separated Document Owner IDs

Example:

null

​
sortBy
enum<string>

Criteria for sorting Documents

Available options:
documentName,
documentTypeName,
documentOwnerUsername,
documentSharingType,
documentStatus,
lastUpdatedOn,
documentDisplayId,
decisionsCount,
delegationsCount,
documentDescription,
responsibleUsername,
uploadedOn,
approvedOn,
reviewedOn,
approvalStatus,
reviewStatus,
documentUploadType,
rank
​
sortOrder
enum<string>

Order for sorting Documents

Available options:
asc,
desc
​
select
enum<string>[]

Comma separated specific Document fields needed in response

Available options:
documentId,
documentName,
documentUrl,
documentTypeName,
documentIcon,
documentDescription,
file,
documentDisplayId,
documentStatus
​
isFavourite
string

Document isFavourite

Example:

"true"

​
decisionLinkAllowed
boolean

allow document link for decision

Example:

"true"

​
delegationLinkAllowed
boolean

allow document link for delegation

Example:

"true"

​
responsibleUserId
string[]

Comma separated Responsible User IDs

Example:

null

​
reviewerUserId
string[]

Comma separated Reviewer User IDs

Example:

null

​
approverUserId
string[]

Comma separated Approver User IDs

Example:

null

​
documentUploadType
object

Document Upload Type/Source

​
createdStartDate
string

Start date time for date range filter on document created at

Example:

"2025-03-05T11:49:50.577Z"

​
createdEndDate
string

End date time for date range filter on document created at

Example:

"2025-03-05T11:49:50.577Z"

​
updatedStartDate
string

Start date time for date range filter on document updated at

Example:

"2025-03-05T11:49:50.577Z"

​
updatedEndDate
string

End date time for date range filter on document updated at

Example:

"2025-03-05T11:49:50.577Z"

​
linkedDocumentIds
string[]

Comma separated Document IDs already linked to decision/delegation (this is used to include already linked ARCHIVED documents in the list)

Example:

null

​
userId
string

Response

200 - application/json

Documents list retrieved successfully

​
statusCode
number
required
Example:

200

​
timestamp
string
required
Example:

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

​
message
string
required
Example:

"Success"

​
data
object