GET /public/v1/documents

Servers

https://api.pandadoc.com

Query parameters

Name	Type	Required	Description
`count`	Integer	No	Specify how many document results to return. Default is 50 documents, maximum is 100 documents.
`created_to`	String	No	Return results where the `date_created` field (ISO 8601) is less than this value.
`deleted`	Boolean	No	Returns only the deleted documents.
`q`	String	No	Search query. Filter by document reference number (this token is stored on the template level) or name.
`created_from`	String	No	Return results where the `date_created` field (ISO 8601) is greater than or equal to this value.
`metadata[]`	Array	No	Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required.
`status`	Integer	No	Specify the status of documents to return. 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 Possible values: `11` `12` `13` `0` `1` `2` `3` `4` `5` `6` `7` `8` `9` `10`
`tag`	String	No	Search tag. Filter by document tag.
`order_by`	String	No	Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. Possible 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"`
`template_id`	String	No	Specify the template used for documents creation. Parameter can't be used with form_id.
`id`	String	No
`page`	Integer	No	Specify which page of the dataset to return.
`completed_to`	String	No	Return results where the `date_completed` field (ISO 8601) is less than or equal to this value.
`modified_to`	String	No	Return results where the `date_modified` field (iso-8601) is less than this value.
`status__ne`	Integer	No	Specify the status of documents to return (exclude). 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 Possible values: `11` `12` `13` `0` `1` `2` `3` `4` `5` `6` `7` `8` `9` `10`
`form_id`	String	No	Specify the form used for documents creation. This parameter can't be used with template_id.
`contact_id`	String	No	Returns results where 'contact_id' is present in document as recipient or approver
`folder_uuid`	String	No	The UUID of the folder where the documents are stored.
`membership_id`	String	No	Returns results where 'membership_id' is present in document as owner (should be member uuid)
`completed_from`	String	No	Return results where the `date_completed` field (ISO 8601) is greater than or equal to this value.
`modified_from`	String	No	Return results where the `date_modified` field (iso-8601) is 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.