get https://api.pandadoc.com/public/v1/documents?q=&tag=&status=&count=&page=&metadata=&id=&template_id=&folder_uuid=&form_id=&order_by=&created_from=&created_to=&modified_from=&modified_to=&completed_from=&completed_to=&membership_id=&contact_id=
Optionally filter by a search query or tags.
Listing Documents Efficiently
If your workspace contains hundreds of thousands of documents, you may experience higher latency of your requests.
Pro tip
Using
order_by = date_createdensures stable performance and quick responses.If you need to order documents by a different field, use the
created_fromandcreated_toparameters to limit the result set, and run requests in batches.
Usage examples
count=100&order_by=date_created&created_from=2023-08-01T00:00:00.000000Z&created_to=2023-09-01T00:00:00.000000Z
This request returns only documents created in August.- The next request is for
page = 2(still listing documents created in August):
count=100&order_by=date_created&created_from=2023-08-01T00:00:00.000000Z&created_to=2023-09-01T00:00:00.000000Z&page=2 - Once you receive an empty response, it means you listed all the documents created in the provided time range. Continue listing them by setting another month:
count=100&order_by=date_created&created_from=2023-07-01T00:00:00.000000Z&created_to=2023-08-01T00:00:00.000000Z
This request lists the documents created in July 2023.
Caveats
- Remove unused parameters with empty values, otherwise you get the 400 error.
- By default, PandaDoc API lists documents sorted by the
date_status_changedattribute.