v2

latestOpenAPI 3.0.32026-07-31890635.1 KB
Document

Find documents

Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Find documents based on a search criteria

get/document

Query parameters

querystring

The search query.

pagenumber

The pagination page number, starts at 1.

perPagenumber

The number of items per page.

templateIdnumber

Filter documents by the template ID used to create it.

source'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK'

Filter documents by how it was created.

status'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED'

Filter documents by the current status

folderIdstring

Filter documents by folder ID

orderByColumn'createdAt'
orderByDirection'asc' | 'desc'

Response

Successful response

countnumber required
currentPagenumber required
perPagenumber required
totalPagesnumber required