Skip to main content
GET
Get
The /packages/{packageId} endpoint allows you to retrieve detailed information about a specific package by its unique identifier.

Request

Request

Parameters

string
required
The unique identifier of the package you want to retrieve.

Response

string
Unique identifier for the package.
string
Unique identifier for the organization that owns the package.
string
Identifier for the member who created/owns the package.
string
nullable
Team identifier associated with the package. (optional)
string
nullable
Folder identifier where the package is stored. (optional)
boolean
Set to true if the package is shared.
string
nullable
Current scheduled meeting ID for the package (if applicable).
string
nullable
ID of the template the package was created from (if applicable).
string
nullable
ID of the form the package was created from (if applicable).
string
nullable
ID of the API key used to create the package (if created via API key).
string
Display name of the package.
string
nullable
Category for the package. (optional)
string
nullable
Client reference number. (optional)
string
nullable
Matter reference number. (optional)
string
nullable
Description of the package. (optional)
string
nullable
Message included when the package was sent. (optional)
string
nullable
Message explaining why the package was rescinded. (optional)
string
nullable
Reminder message for signers. (optional)
string
Creation time (ISO 8601 date-time).
string
nullable
Reminder time (ISO 8601 date-time).
string
nullable
Retention expiry time (ISO 8601 date-time).
string
nullable
Time the package was rescinded (ISO 8601).
string
nullable
Time the package was deleted (ISO 8601).
string
Deadline for signing (ISO 8601 date-time).
string
Last modification time (ISO 8601 date-time).
object
Package options.
boolean
Set to true if the package is protected by a security passphrase.
string
Language/locale for the package.
string
Time zone for package date/time presentation.
object
Formatting options for dates and presentation.
number
Number of signed revisions across package documents.
number
Total number of revisions across package documents.
string
nullable
Restriction type applied to the package. (optional)
boolean
Set to true if the package was created via the API.
string
Package type identifier.
string
Current state of the package.
Map<string, object>
nullable
Arbitrary external data attached to the package.
string
Package version or timestamp (ISO 8601).
object
nullable
If the package is scheduled for a meeting, the meeting details.
object[]
Documents that belong to the package.
object[]
Signers for the package.
object[]
Recipients related to the package (additional recipients beyond signers).
object[]
Verification records associated with the package.
object[]
Consent records associated with the package.4.2