Theme switcher

List a document record by docId

Header Parameters

Authorizationstring

This header parameter is used to authenticate the API request and ensure secure access to the document record by providing a valid authorization token.

Query Parameters

includeMappingboolean
Default value
false
returnUniqueFieldValuesboolean
Default value
false

Path Parameters

docIdstring Required

The user provided external document ID

Minimum
1

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 API request, indicating whether the request was successful or encountered any issues.

Enum values:
IN_PROGRESSREADYFAILED
customModelStatusobject

Show child attributes

dateModifiedstring Required

This response parameter indicates the date and time when the document record was last modified, assisting in tracking changes and updates.

fieldsarray Required

This response parameter returns a list of fields associated with the document record, providing detailed information about each field.

Show child attributes

provisionsarray Required

This response parameter outlines the provisions or conditions specified in the document record, detailing any requirements or restrictions.

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 API request, providing details on the nature of the error for troubleshooting purposes.

403
Object
Forbidden

Response Attributes

errorstring

This response parameter indicates any errors encountered during the API request, providing details on the nature of the error for troubleshooting purposes.

404
Object
Requested resource not found

Response Attributes

errorstring

This response parameter indicates any errors encountered during the API request, providing details on the nature of the error for troubleshooting purposes.

500
Object
Internal/Unexpected Error

Response Attributes

errorstring

This response parameter indicates any errors encountered during the API request, providing details on the nature of the error for troubleshooting purposes.

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