Documents

Get a document

Get document details by specifying a document id in the request URL. To find a document by external id when you are not its owner, first use GET /v1/documents?external_id={externalId}&showall=true, then pass the returned id here. showall affects the list lookup only; this endpoint still checks your access to the document. rejection_reason is the reason the recipient gave when rejecting the document, as in get document status; it is null when the document is not rejected or no reason was given.

get/v1/documents/{id}

Request

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

Path parameters

idstring required

Id of the document.

Query parameters

with_pagesstring

Include document pages. Any non-empty value other than 0 turns it on, including false.

with_small_pagesstring

Include document pages with small thumbnails. Any non-empty value other than 0 turns it on, including false.

with_statsstring

Include document statistics. Any non-empty value other than 0 turns it on, including false.

with_attachmentsstring

Include document attachments. Any non-empty value other than 0 turns it on, including false.

in_objectstring

Return a one-element array instead of the document. Its item holds the document together with the entity, the first recipient and the custom fields. Any non-empty value other than 0 turns it on, including false.

Response

The request succeeded.

OR

Changes

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