Search documents

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

import requests

url = "https://staging.api.us.aptlydone.com/document/v1/documents/global-search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://staging.api.us.aptlydone.com/document/v1/documents/global-search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.api.us.aptlydone.com/document/v1/documents/global-search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.api.us.aptlydone.com/document/v1/documents/global-search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging.api.us.aptlydone.com/document/v1/documents/global-search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:12:24.382Z",
  "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"
      }
    ]
  }
}

GET

documents

global-search

Search documents

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

import requests

url = "https://staging.api.us.aptlydone.com/document/v1/documents/global-search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://staging.api.us.aptlydone.com/document/v1/documents/global-search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.api.us.aptlydone.com/document/v1/documents/global-search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.api.us.aptlydone.com/document/v1/documents/global-search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging.api.us.aptlydone.com/document/v1/documents/global-search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:12:24.382Z",
  "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<uuid>

required

Tenant ID

Example:

"bc386711-9f0b-4c20-8c73-d623cf4e8f02"

status

object[]

Comma separated Document Status values

string

Document search string

Example:

""

documentType

string<uuid>[]

Comma separated Document Type IDs

Example:

null

oversight

object[]

Comma separated Oversight Status values

Comma separated Document Sharing Type values

documentOwnerId

string<uuid>[]

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

Example:

"documentName"

sortOrder

enum<string>

Order for sorting Documents

Available options:

asc,

desc

Example:

"asc"

select

string[]

Comma separated specific Document fields needed in response

Example:

""

isFavourite

string

Document isFavourite

Example:

"true"

decisionLinkAllowed

string

allow document link for decision

Example:

"true"

delegationLinkAllowed

string

allow document link for delegation

Example:

"true"

responsibleUserId

string<uuid>[]

Comma separated Responsible User IDs

Example:

null

reviewerUserId

string<uuid>[]

Comma separated Reviewer User IDs

Example:

null

approverUserId

string<uuid>[]

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

selectedTab

enum<string>

Selected tab context (not used in list API)

Available options:

active,

inactive,

favorites,

all

Example:

"active"

Response

200 - application/json

Documents list retrieved successfully

statusCode

number

required

Example:

200

timestamp

string

required

Example:

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

message

string

required

Example:

"Success"

data

object

Show child attributes

API Authentication

Decisions

Delegations

Matrices

Actions

Documents

Tenants

Users

Groups

Positions

Reporting

Notifications

Search documents

Authorizations

Query Parameters

Response