Theme switcher

List a document record

Header Parameters

Authorizationstring

This header parameter is used to authenticate the request to access the document record. It contains the necessary credentials for authorization.

Query Parameters

includeMappingboolean
Default value
false
returnUniqueFieldValuesboolean
Default value
false
attachedDataKeysstring

Path Parameters

evisortIdstring Required

The Evisort document handler ID (numeric digits).

Minimum
1
Pattern
^[0-9]+$

Response

200
Object
Document object

Response Attributes

docIdstring Required

Could be null for documents not uploaded via the API

Nullable:
True
evisortIdinteger Required

Evisort document handler ID (integer). POST /documents and /search return this same id as a string.

statusstring Required

This response parameter specifies the status of the document record. It indicates the current state or condition of the document, such as 'active' or 'inactive'.

Enum values:
IN_PROGRESSREADYFAILED
customModelStatusobject

Show child attributes

dateModifiedstring Required

This response parameter indicates the date when the document record was last modified. It provides the timestamp of the most recent modification made to the document.

fieldsarray Required

This response parameter specifies the fields included in the document record. It provides information about the specific data fields available for the document.

Show child attributes

provisionsarray Required

This response parameter outlines the provisions or terms associated with the document record. It specifies the conditions or requirements related to the document.

Show child attributes

namestring Required

The filename of the document

pathstring Required

The path of the document

401
Object
Access token is missing or invalid

Response Attributes

errorstring

This response parameter indicates any errors encountered during the request for the document record. It provides information about any issues or problems with retrieving the document.

403
Object
Forbidden

Response Attributes

errorstring

This response parameter indicates any errors encountered during the request for the document record. It provides information about any issues or problems with retrieving the document.

404
Object
Requested resource not found

Response Attributes

errorstring

This response parameter indicates any errors encountered during the request for the document record. It provides information about any issues or problems with retrieving the document.

500
Object
Internal/Unexpected Error

Response Attributes

errorstring

This response parameter indicates any errors encountered during the request for the document record. It provides information about any issues or problems with retrieving the document.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot