Skip to content

Get envelope

Request

Returns a specific envelope.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

envelopeIdstring, (uuid)required

Unique identifier of the envelope

GET
/api/v1/organizations/{organizationId}/envelopes/{envelopeId}
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/envelopes/{envelopeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring, (uuid)required

The envelope ID.

Example:"00000000-0000-0000-0000-000000000001"
namestring or null

The envelope name.

Example:"Contract for Mario Rossi"
statusstringrequired

The current status of the envelope.

Example:"Draft"
createdAtstring, (date-time)required

When the envelope was created.

Example:"2025-01-01T10:00:00Z"
updatedAtstring, (date-time)required

When the envelope was last updated.

Example:"2025-01-01T10:00:00Z"
expirationAbsoluteEnvelopeExpirationResponse (object) or RelativeEnvelopeExpirationResponse (object) or (any or null)
One of:

Absolute expiration configuration.

reminderobject(EnvelopeReminderResponse)

Reminder configuration.

stagesArray of objects(EnvelopeStageSummaryResponse)required

The stages of the envelope.

filesArray of objects(EnvelopeFileSummaryResponse)required

The files of the envelope.

sentAtstring or null, (date-time)

When the envelope was sent.

Example:"2025-01-02T12:00:00Z"
qualifiedTimeStampbooleanrequired

Whether all signatures in the envelope must use a qualified timestamp server.

Example:true
signatureFormatstring(SignatureFormat)required

The signature format for an envelope or template.

Enum:"Pades""Cades"
signatureReasonstring or null

The signature reason persisted on the envelope, or null.

Example:"Approved by Mario Rossi"
statusChangeReasonstring or null

The reason for the envelope's terminal status change: the rejection reason when rejected, the cancellation reason when cancelled, otherwise null.

Example:"Document no longer required"
agreementsArray of objects or null(Agreement)

The agreements per language, or null when no custom agreements are configured.

fileRestrictedVisibilitybooleanrequired

Whether file visibility is restricted per recipient.

Example:false
afterSendRedirectUrlstring or null

The URL to redirect to after sending the envelope.

Example:"https://example.com/envelope-sent"
bulkEnvelopeIdstring or null, (uuid)

The ID of the bulk envelope this envelope was generated from, or null when the caller has no access to it or it is not a bulk child.

Example:"00000000-0000-0000-0000-000000000002"
Response
{ "id": "00000000-0000-0000-0000-000000000001", "name": "Contract for Mario Rossi", "status": "Draft", "createdAt": "2025-01-01T10:00:00+00:00", "updatedAt": "2025-01-01T10:00:00+00:00", "expiration": { "mode": "Absolute", "expiresAt": "2026-12-11T14:00:03.1810163+00:00" }, "reminder": { "enabled": true, "firstReminderInDays": 5, "resendIntervalInDays": 3, "beforeExpirationInDays": 2 }, "stages": [ { … } ], "files": [ { … } ], "sentAt": null, "qualifiedTimeStamp": true, "signatureFormat": "Pades", "signatureReason": "Approved by Mario Rossi", "statusChangeReason": "Document no longer required", "agreements": null, "fileRestrictedVisibility": false, "afterSendRedirectUrl": "https://example.com/envelope-sent", "bulkEnvelopeId": null }