API Reference
Access Dev CenterSuggest a FeatureContact SupportCreate SandboxRequest a Demo

List Documents

get
https://api.pandadoc.com/public/v1/documents

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

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

Query Params
string

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

string

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

string

Filters by the folder where the documents are stored.

string

Filters by recipient or approver with this 'contact_id'.

integer

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

integer
≥ 1

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

string
enum
Defaults to date_status_changed

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

string

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

string

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

boolean

Returns only the deleted documents.

string

Searches for document by it's id.

string

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

string

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

string

Filter documents by the owner's 'membership_id'.

metadata
array of strings

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.

metadata
string

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

string

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

string

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

integer
enum

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
integer
enum

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
string

Filters documents by tag.

Responses

Updated 11 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago