Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB
Documents

List Documents

This endpoint will let you list and search for the documents.

Here you can find how to filter, search and order documents.

get/public/v1/documents

Query parameters

template_idstring

Filters by parent template. This Parameter can't be used with form_id.

form_idstring

Filters by parent form. This parameter can't be used with template_id.

folder_uuidstring

Filters by the folder where the documents are stored.

contact_idstring

Filters by recipient or approver with this 'contact_id'.

countinteger

Limits the size of the response. Default is 50 documents, maximum is 100 documents.

pageinteger

Paginates the search result. Increase value to get the next page of results.

order_by'name' | 'date_created' | 'date_status_changed' | 'date_of_last_action' | 'date_modified' | 'date_sent' | 'date_completed' | 'date_expiration' | 'date_declined' | 'status' | '-name' | '-date_created' | '-date_status_changed' | '-date_of_last_action' | '-date_modified' | '-date_sent' | '-date_completed' | '-date_expiration' | '-date_declined' | '-status'

Defines the sorting of the result. Use date_created for ASC and -date_created for DESC sorting.

created_fromstring date-time

Limits results to the documents with the date_created greater than or equal to this value.

created_tostring date-time

Limits results to the documents with the date_created less than this value.

deletedboolean

Returns only the deleted documents.

idstring

Searches for document by it's id.

completed_fromstring date-time

Limits results to the documents with the date_completed greater than or equal to this value.

completed_tostring date-time

Limits results to the documents with the date_completed less than this value.

membership_idstring

Filter documents by the owner's 'membership_id'.

metadatastring[]

Filters documents by metadata. Pass metadata in the format of metadata_{metadata-key}={metadata-value} such as metadata_opportunity_id=2181432. The metadata_ prefix is always required.

modified_fromstring date-time

Limits results to the documents with the date_modified greater than or equal to this value.

modified_tostring date-time

Limits results to the documents with the date_modified less than this value.

qstring

Filters documents by name or reference number (stored on the template level).

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14
Example:12

Filters documents by the status.

  • 0: document.draft
  • 1: document.sent
  • 2: document.completed
  • 3: document.uploaded
  • 4: document.error
  • 5: document.viewed
  • 6: document.waiting_approval
  • 7: document.approved
  • 8: document.rejected
  • 9: document.waiting_pay
  • 10: document.paid
  • 11: document.voided
  • 12: document.declined
  • 13: document.external_review
  • 14: document.scheduled
status__ne0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14
Example:12

Exludes documents with this status.

  • 0: document.draft
  • 1: document.sent
  • 2: document.completed
  • 3: document.uploaded
  • 4: document.error
  • 5: document.viewed
  • 6: document.waiting_approval
  • 7: document.approved
  • 8: document.rejected
  • 9: document.waiting_pay
  • 10: document.paid
  • 11: document.voided
  • 12: document.declined
  • 13: document.external_review
  • 14: document.scheduled
tagstring

Filters documents by tag.

Response

OK

Example response

{
  "results": [
    {
      "id": "ZsiBHUyksDoKActQNGz542",
      "name": "Sample Document",
      "status": "document.draft",
      "date_created": "2021-10-08T11:06:32.337395Z",
      "date_modified": "2021-10-08T11:06:32.337395Z",
      "date_completed": "2021-10-08T11:06:32.337395Z",
      "expiration_date": "2021-10-08T11:06:32.337395Z",
      "version": "2"
    }
  ]
}