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

template_id

string

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

form_id

string

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

folder_uuid

string

Filters by the folder where the documents are stored.

contact_id

string

Filters by recipient or approver with this 'contact_id'.

count

integer

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

page

integer

≥ 1

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

order_by

string

Defaults to date_status_changed

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

created_from

string

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

created_to

string

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

deleted

boolean

Returns only the deleted documents.

string

Searches for document by it's id.

completed_from

string

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

completed_to

string

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

membership_id

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

modified_from

string

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

modified_to

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).

status

integer

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

status__ne

integer

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

tag

string

Filters documents by tag.

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.pandadoc.com/public/v1/documents \
3
     --header 'Authorization: API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
22
 
1
{
2
  "results": [
3
    {
4
      "id": "XjV64iXRJMerjSpk428QSF",
5
      "name": "Sample Document",
6
      "status": "document.draft",
7
      "date_created": "2024-07-02T16:21:35.770196Z",
8
      "date_modified": "2024-07-02T16:21:37.696724Z",
9
      "expiration_date": null,
10
      "version": "2"
11
    },
12
    {
13
      "id": "6NbHUUu6uuYN2tqJvgtf9h",
14
      "name": "Services Invoice",
15
      "status": "document.completed",
16
      "date_created": "2024-01-25T15:35:27.186107Z",
17
      "date_modified": "2024-06-21T15:07:34.192101Z",
18
      "expiration_date": "2024-08-20T15:07:32.869161Z",
19
      "version": "2"
20
    }
21
  ]
22
}

200OK

400Bad Request

401Authentication error

403Permission error

429Too Many Requests