Skip to main content
GET
The controlled document library. control_state is what the calendar says, status is what a

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
document_number
string
title
string
description
string
document_category_id
string
category
string
document_folder_id
string
folder
string
folder_is_restricted
string
document_type
string
status
string
current_version_number
string
file_id
string
file_name
string
content_type
string
size_bytes
string
file_is_available
string
owner_user_id
string
owner
string
approved_by_user_id
string
approved_by
string
approved_at
string
language_id
string
language
string
issued_on
string
effective_from
string
expires_on
string
review_due_on
string
review_interval_months
string
issuing_body
string
reference_number
string
withdrawal_reason
string
control_state
string
days_until_expiry
string
days_until_review
string
linked_records
string
version_count
string
pending_version_number
string
is_available_offline
string
is_active
string
created_at
string
updated_at
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

approved_at
string<timestamp with time zone>
approved_by
string<character varying>
Maximum string length: 200
approved_by_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

category
string<character varying>
Maximum string length: 200
content_type
string<character varying>
Maximum string length: 150
control_state
string<character varying>
created_at
string<timestamp with time zone>
current_version_number
integer<integer>
days_until_expiry
integer<integer>
days_until_review
integer<integer>
description
string<text>
document_category_id
string<uuid>

Note: This is a Foreign Key to document_category_settings.id.

document_folder_id
string<uuid>

Note: This is a Foreign Key to document_folders.id.

document_number
string<character varying>
Maximum string length: 80
document_type
string<character varying>
Maximum string length: 40
effective_from
string<date>
expires_on
string<date>
file_id
string<uuid>
file_is_available
boolean<boolean>
file_name
string<character varying>
Maximum string length: 250
folder
string<character varying>
Maximum string length: 150
folder_is_restricted
boolean<boolean>
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
is_available_offline
boolean<boolean>
issued_on
string<date>
issuing_body
string<character varying>
Maximum string length: 200
language
string<character varying>
Maximum string length: 100
language_id
string<uuid>
linked_records
integer<bigint>
owner
string<character varying>
Maximum string length: 200
owner_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

pending_version_number
integer<integer>
reference_number
string<character varying>
Maximum string length: 120
review_due_on
string<date>
review_interval_months
integer<integer>
row_version
integer<bigint>
size_bytes
integer<bigint>
status
string<character varying>
Maximum string length: 20
title
string<character varying>
Maximum string length: 250
updated_at
string<timestamp with time zone>
version_count
integer<bigint>
withdrawal_reason
string<character varying>
Maximum string length: 500