Documents

Get documents

Get a list of available documents.

get/v1/documents

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/documents
  • Auth: HTTP bearer

Query parameters

sort_bystring

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_orderstring

Sort order when sort_by is set: asc or desc. Defaults to asc.

showteamstring

Set to true to include documents from team members.

showallstring

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.

external_idstring

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.

offsetnumber

Start the list from this record. Defaults to 0.

limitnumber

Number of records to list. Defaults to 100, which is also used for a value of 0 or less.

external_client_idstring

External client id set when the document was created.

filterstring

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.

idstring required

Id of the document.

namestring required

Name of the document as it is presented to the recipients.

typestring required

Document type, which sets the defaults and the look of the document.

external_idstring nullable required

External identifier of the document, or null when it was never set.

is_privateboolean required

Whether the document can only be viewed by its owner.

is_signingboolean required

Whether the document is signable.

company_namestring required

Company the document is sent to.

user_idstring required

Id of the user that owns the document.

sender_namestring required

Full name of the user that owns the document.

sender_thumbstring required

URL of the avatar of the user that owns the document.

status'draft' | 'archived' | 'expired' | 'hardbounced' | 'importing' | 'lost' | 'processing' | 'recalled' | 'rejected' | 'reviewed' | 'scheduled' | 'sealed' | 'sent' | 'signed' | 'signedwithoutverification' | 'viewed' required

Current status of the document.

valuenumber required

Monetary value of the document in the entity currency.

tagsstring required

Comma separated document tags.

sign_datestring nullable required

When the last required signature was collected, or null while the document is unsigned.

expiration_datestring nullable required

When the document stops being available to the recipients, or null when it never expires.

created_atstring nullable required

When the document was created.

updated_atstring nullable required

When the document was last updated, or null when that is unavailable.

thumb_urlstring

URL of the thumbnail of the first document page. Only returned when filter is archive.

Changes

No recorded changes to this operation across all 1 revision of this API.