v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Documents > Document

Reads all Documents

get/api/2026-07-01/resources/documents/documents

Query parameters

by_bookkeeper_documentsboolean

flag to indicate if the document belongs to a bookkeeper.

Example:true

flag to indicate if the document belongs to a bookkeeper.

by_pending_assignmentboolean required

flag to indicate if the document is pending assignment.

Example:true

flag to indicate if the document is pending assignment.

by_trash_binboolean required

flag to indicate if the document is in the trash bin.

Example:true

flag to indicate if the document is in the trash bin.

by_without_folderboolean

flag to indicate if the document doesn't have a folder.

Example:true

flag to indicate if the document doesn't have a folder.

employee_ids[]string[]

list of employee identifiers.

[
  "1",
  "2",
  "3"
]

folder_idstring

folder identifier.

Example:1

folder identifier.

ids[]string[]

list of document identifiers.

[
  "1",
  "2",
  "3"
]

leave_idstring

leave identifier associated to the document, refers to /timeoff/leaves endpoint.

Example:1

leave identifier associated to the document, refers to /timeoff/leaves endpoint.

Response

Example response

{
  "data": [
    {
      "author_id": "1",
      "company_id": "1",
      "content_type": "application/pdf",
      "created_at": "2020-01-01T00:00:00Z",
      "employee_id": "1",
      "extension": "pdf",
      "file_size": 1024,
      "filename": "document.pdf",
      "folder_id": "1",
      "id": "1",
      "is_company_document": true,
      "is_management_document": true,
      "is_pending_assignment": true,
      "leave_id": "1",
      "public": true,
      "signature_status": "pending",
      "space": "company_public",
      "updated_at": "2020-01-01T00:00:00Z",
      "deleted_at": "2020-01-01T00:00:00Z"
    }
  ]
}