# Get envelope

Returns a specific envelope.

Endpoint: GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}
Version: v1
Security: Bearer, PersonalAccessToken

## Security:

  - `Bearer` (unknown)
    http bearer JWT

  - `PersonalAccessToken` (unknown)
    apiKey in header Personal-Access-Token

## Path parameters:

  - `organizationId` (string, required)
    Unique identifier of the organization

  - `envelopeId` (string, required)
    Unique identifier of the envelope

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `id` (string, required)
    The envelope ID.
    Example: 00000000-0000-0000-0000-000000000001

  - `name` (string)
    The envelope name.
    Example: Contract for Mario Rossi

  - `status` (string, required)
    The current status of the envelope.
    Example: Draft

  - `createdAt` (string, required)
    When the envelope was created.
    Example: 2025-01-01T10:00:00Z

  - `updatedAt` (string, required)
    When the envelope was last updated.
    Example: 2025-01-01T10:00:00Z

  - `expiration` (any)
    The expiration settings.

  - `expiration.expiresAt` (string)
    The exact expiration date and time.
    Example: 2025-12-31T23:59:59Z

  - `expiration.mode` (string, required)
    Enum: "Absolute"

  - `expiration.afterSendInSeconds` (integer)
    Seconds after sending before the envelope expires.
    Example: 604800

  - `expiration.mode` (string, required)
    Enum: "Relative"

  - `reminder` (object)
    Reminder configuration.

  - `reminder.enabled` (boolean, required)
    Whether reminders are enabled.
    Example: true

  - `reminder.firstReminderInDays` (integer, required)
    Days after sending before the first reminder.
    Example: 5

  - `reminder.resendIntervalInDays` (integer, required)
    Days between subsequent reminders.
    Example: 3

  - `reminder.beforeExpirationInDays` (integer, required)
    Days before expiration to send the last reminder.
    Example: 2

  - `stages` (array, required)
    The stages of the envelope.

  - `stages.id` (string, required)
    The stage ID.
    Example: 00000000-0000-0000-0000-000000000010

  - `stages.name` (string, required)
    The stage name.
    Example: Stage 1

  - `stages.sortOrder` (integer, required)
    The position of the stage in the sequence.
    Example: 1

  - `files` (array, required)
    The files of the envelope.

  - `files.id` (string, required)
    The file ID.
    Example: 00000000-0000-0000-0000-000000000020

  - `files.name` (string, required)
    The file name.
    Example: contract.pdf

  - `files.sortOrder` (integer, required)
    The file sort order.
    Example: 1

  - `sentAt` (string)
    When the envelope was sent.
    Example: 2025-01-02T12:00:00Z

  - `qualifiedTimeStamp` (boolean, required)
    Whether all signatures in the envelope must use a qualified timestamp server.
    Example: true

  - `signatureFormat` (string, required)
    The signature format for an envelope or template.
    Enum: "Pades", "Cades"

  - `signatureReason` (string)
    The signature reason persisted on the envelope, or null.
    Example: Approved by Mario Rossi

  - `statusChangeReason` (string)
    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

  - `agreements` (array)
    The agreements per language, or null when no custom agreements are configured.

  - `agreements.language` (string, required)
    The BCP-47 language code for this agreement.
    Example: en

  - `agreements.title` (string)
    The agreement title, or null when not set.
    Example: Please review the agreement

  - `agreements.body` (string, required)
    The agreement body.
    Example: Please read and accept the agreement.

  - `fileRestrictedVisibility` (boolean, required)
    Whether file visibility is restricted per recipient.
    Example: false

  - `afterSendRedirectUrl` (string)
    The URL to redirect to after sending the envelope.
    Example: https://example.com/envelope-sent

  - `bulkEnvelopeId` (string)
    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 400:

  - `400` (unknown)
    Bad Request

## Response 400 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 404:

  - `404` (unknown)
    Not Found

## Response 404 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 422:

  - `422` (unknown)
    Unprocessable Content

## Response 422 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 500:

  - `500` (unknown)
    Internal Server Error

## Response 500 fields (application/json):

  - `errors` (array, required)

  - `errors.errorId` (string, required)

  - `errors.field` (string)

  - `errors.message` (any, required)

  - `errors.messageEn` (any, required)

  - `errors.additionalData` (object)

## Response 200 examples:

  - `PAdES, absolute expiration (default)` (unknown)

  - `PAdES, relative expiration` (unknown)

  - `CAdES` (unknown)

