List Documents

List Documents

Query Parameters
per_page number Define the number of items per page, default is 100
page number Define the page number, default is 1
term string Search term
due_date_between string Filter by due date range, format: YYYY-MM-DD|YYYY-MM-DD
responsible_user string Filter by responsible user
company string Filter by company
tenancy string Filter by tenancy
folder string Filter by folder
custom_tags string Filter by custom tags
document_type string Filter by document type
validity_type string Filter by validity type
status string Filter by document status

Responses

200 Successful response with list of documents Schema — OPTIONAL id string — OPTIONAL Document ID name string — OPTIONAL Document name description string — OPTIONAL Document description issue_date date — OPTIONAL Document issue date due_date date — OPTIONAL Document due date company object — OPTIONAL national_registry_number string — OPTIONAL Company CPF/CNPJ name string — OPTIONAL Company alias name tenancy object — OPTIONAL id string — OPTIONAL Tenancy ID name string — OPTIONAL Tenancy name created_by_user object — OPTIONAL id string — OPTIONAL User ID name string — OPTIONAL User name document_type object — OPTIONAL id string — OPTIONAL Document type ID name string — OPTIONAL Document type name validation object — OPTIONAL validity_type string — OPTIONAL Document validity type validity_value string — OPTIONAL Document validity value default_days_expiration integer — OPTIONAL Default days for expiration status object — OPTIONAL key string — OPTIONAL Possible values: [VALID, EXPIRED, ARCHIVED, ALL, VALIDATION_PERIOD] Document status key name string — OPTIONAL Formatted document status situation object — OPTIONAL key string — OPTIONAL Possible values: [ISSUED, EXEMPT, PENDING, TEMPORARY, PROTOCOLED, NOT_APPLICABLE, CANCELED, DRAFT, RELATED_MATRIX, DISPENSED] Document situation key name string — OPTIONAL Formatted document situation folder object — OPTIONAL id string — OPTIONAL Folder ID name string — OPTIONAL Folder name related_resources object — OPTIONAL type string — OPTIONAL Related resource type resources object[] — OPTIONAL id string — OPTIONAL Resource ID complement string — OPTIONAL Resource complement (CPF/CNPJ for partners/companies, name for collaborators/wastes/containers, code for environmental licenses, plate for vehicles, formatted value for custom fields) responsible_users object[] — OPTIONAL id string — OPTIONAL User ID name string — OPTIONAL User name responsible_roles object[] — OPTIONAL id string — OPTIONAL Role ID name string — OPTIONAL Role name (custom or standard) scheduled_execution_status string — OPTIONAL Document scheduled execution status observation string — OPTIONAL Document observation is_matrix_additional_document boolean — OPTIONAL Whether document is matrix additional document has_unconformity boolean — OPTIONAL Whether document has unconformity is_balance_control boolean — OPTIONAL Whether document is balance control share_histories object[] — OPTIONAL share_type string — OPTIONAL Share type shared_by_tenancy object — OPTIONAL id string — OPTIONAL Tenancy ID name string — OPTIONAL Tenancy name shared_with_tenancy object — OPTIONAL id string — OPTIONAL Tenancy ID name string — OPTIONAL Tenancy name shared_with_email string — OPTIONAL Email shared with status string — OPTIONAL Possible values: [PENDING, DISAPPROVED, APPROVED, VIEWED, EXPIRED, DELETED, SHARED, COPIED, REQUESTED, NOT_SHARED, PENDING_RECEIVED, PENDING_SUBMITTED, DISAPPROVED_RECEIVED] Share status approval_observation string — OPTIONAL Approval observation viewed_at date-time — OPTIONAL When share was viewed attachments object[] — OPTIONAL Document attachments id string — OPTIONAL Attachment ID type string — OPTIONAL Attachment type custom_tags object[] — OPTIONAL id string — OPTIONAL Tag ID name string — OPTIONAL Tag name created_at date-time — OPTIONAL Document creation timestamp updated_at date-time — OPTIONAL Document last update timestamp