Get Packages

Use this API to retrieve all document packages by the group identifier to track the delivery status.

This API endpoint added with the 24.3 release of Encompass.

Usage Note

Document packages cancelled due to default are not included in the response.

Path Params
string
required

The type of the entity represented by the grouping and the individual of which is represented by the id. Encompass uses the loans namespace. Example: loans

string
required

The unique identifier within the instance/namespace combination. Encompass uses loan GUID. It is not required to be a GUID.
Example: d928a96a-e575-4350-a1d7-479f2321c57b

Query Params
string

Name of the predefined subset of the requested packages.

-- pipeline - View will return the tracking information of all the packages that were sent to the currently logged in user.

Filters package to include the following fields:
-- packages: id, cancelled, custom, createdDate, expirationDates, expired, mediaStore, replaced, replacementTracking, tasks, tasksCompleted, voided
-- packages.recipients: id, custom, disableExpiration, portal, release
-- packages.recipients.taskStatuses: id, taskType, viewedDate, viewedIpAddress, viewedDateSynched, completedDate, completedIpAddress, completeDateSynched, completable

string

Use to filter by all, cancelled or non-cancelled packages. Possible values are:
-- True - Cancelled package.
-- False - Non-cancelled package. This is the default.
-- * - All packages.

Headers
string
required

Bearer token.

Responses

Language
Response
Choose an example:
application/json