Documents

Get a document by external id

Get a document by the external id specified when the document was created. This lookup does not accept the showall filter. To find a document owned by another user, use GET /v1/documents?external_id={externalId}&showall=true and use the returned document id with get a document. For a known external id it returns the document shaped like get a document without query options, with two differences: rejection_reason is left out, and tags holds the tags text last sent to create or update the document through the API, so tags added in the app are not listed. When several documents share the external id, the most recently created one is returned.

get/v1/documents/external/{externalId}

Request

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

Path parameters

externalIdstring required

External id the document was created with.

Response

The document without rejection_reason, and with tags as last sent through the API. An unknown external id returns an empty array.

OR

Changes

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