V1 Get Attachment from eFolder

Retrieves the URL for native attachment for a file in the eFolder. The attachment URL is the full URL where the attachment is located in the eFolder. Getting the attachment URL is the first step in retrieving an attachment from the eFolder. This API supports attachment IDs that are in the native format. E.g. Attachment-97f0f34d-7194-4e45-941f-e680dcea91c1.txt.

❗️

Scheduled for Sunset

This API endpoint is scheduled for sunset in release 26.3. Use the following endpoint as alternative:

Usage Note

If the attachment was imported as part of a larger file, the URL will be for the entire imported document. To get the attachment individually, use the Export Attachments API.

Path Params
string
required

Unique identifier assigned to the loan.

string
required

Unique identifier assigned to the attachment. Ex: Attachment-97f0f34d-7194-4e45-941f-e680dcea91c1.txt. Attachment ids in GUID format are not supported.

Query Params
string

Possible values are:

entity - Returns all properties for resource.

id - Returns the attachment ID assigned to the resource.

Body Params
string

The title of the attachment.

string

Unique identifier of the entity. Example: 12345

string

The entity type for documents, is “document”. The entity type for attachments, is “attachment”.

string

Name of the entity.

string

Location of the entity. Example: /v1/documents/123/attachment/12345

int32

The height of the annotation. Example: 0

int32

The visibility type of the annotation.

0 – Public (Default. Viewable by the user who added it.)

1 – Internal (Viewable by any person with Encompass permissions to view annotations.)

2 – Personal (Viewable by everyone and is sent as part of documents.) Example: 0

Headers
string
required

Bearer token

Response

Language
LoadingLoading…
Response
Choose an example:
application/json