Get documents
Get a list of available documents.
Request
- Base URL: https://api.getaccept.com
- URL: https://api.getaccept.com/v1/documents
- Auth: HTTP bearer
Query parameters
Sort the results by name, value, created, status or owner. With filter=signed, created sorts by sign date. Any other value leaves the default order.
Sort order when sort_by is set: asc or desc. Defaults to asc.
Set to true to include documents from team members.
Set to true to include all documents in the entity, including documents owned by other users. Combine with external_id to find a document the caller does not own. This filter applies to this list endpoint; it does not change document-detail access checks. Takes precedence over showteam.
Return documents whose external id, set when the document was created, matches. Pass several comma-separated external ids to match any of them. A value that is an email address instead returns documents that have a recipient with that email.
Start the list from this record. Defaults to 0.
Number of records to list. Defaults to 100, which is also used for a value of 0 or less.
External client id set when the document was created.
Narrow the list with one named filter: archive, won, active, expired, expiring, hot, vod, lost, signed or recalled. Otherwise pass one or more comma-separated statuses, such as sent,viewed, from draft, archived, expired, hardbounced, importing, lost, processing, recalled, rejected, reviewed, scheduled, sealed, sent, signed, signedwithoutverification and viewed. A value that matches no named filter or status returns an empty list. With archive, documents come without recipients and with a thumb_url.
Response
The request succeeded.
Changes
No recorded changes to this operation across all 1 revision of this API.