GET /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.

Servers

https://api.pandadoc.com

Query parameters

Name	Type	Required	Description
`count`	Integer	No	Limits the size of the response. Default is 50 documents, maximum is 100 documents.
`created_to`	String	No	Limits results to the documents with the `date_created` less than this value.
`deleted`	Boolean	No	Returns only the deleted documents.
`q`	String	No	Filters documents by name or reference number (stored on the template level).
`created_from`	String	No	Limits results to the documents with the `date_created` greater than or equal to this value.
`metadata[]`	Array	No	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.
`status`	Integer	No	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 Valid values: `11` `12` `13` `0` `1` `2` `3` `4` `5` `6` `7` `8` `9` `10`
`tag`	String	No	Filters documents by tag.
`template_id`	String	No	Filters by parent template. This Parameter can't be used with form_id.
`order_by`	String	No	Defines the sorting of the result. Use `date_created` for ASC and `-date_created` for DESC sorting. Valid values: `"-date_sent"` `"-date_expiration"` `"date_sent"` `"date_completed"` `"date_declined"` `"-date_of_last_action"` `"-status"` `"name"` `"-name"` `"-date_modified"` `"date_status_changed"` `"date_expiration"` `"status"` `"-date_declined"` `"date_created"` `"date_modified"` `"date_of_last_action"` `"-date_status_changed"` `"-date_completed"` `"-date_created"` Default value: "date_status_changed"
`page`	Integer	No	Paginates the search result. Increase value to get the next page of results.
`id`	String	No
`completed_to`	String	No	Limits results to the documents with the `date_completed` less than this value.
`modified_to`	String	No	Limits results to the documents with the `date_modified` less than this value.
`status__ne`	Integer	No	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 Valid values: `11` `12` `13` `0` `1` `2` `3` `4` `5` `6` `7` `8` `9` `10`
`form_id`	String	No	Filters by parent form. This parameter can't be used with template_id.
`contact_id`	String	No	Filters by recipient or approver with this 'contact_id'.
`folder_uuid`	String	No	Filters by the folder where the documents are stored.
`membership_id`	String	No	Filter documents by the owner's 'membership_id'.
`completed_from`	String	No	Limits results to the documents with the `date_completed` greater than or equal to this value.
`modified_from`	String	No	Limits results to the documents with the `date_modified` greater than or equal to this value.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.