List documents

📘

List by Linked Objects

To get a list of documents by their linked objects from external integrated systems.
Use a separate endpoint

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_created ensures stable performance and quick responses.

If you need to order documents by a different field, use the created_from and created_to parameters to limit the result set, and run requests in batches.

Usage examples

  1. 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.
  2. 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
  3. 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

  • By default, PandaDoc API lists documents sorted by the date_status_changed attribute.
Language
Authorization
Click Try It! to start a request and see the response here!