Sign in

v2

latestOpenAPI 3.1.02026-08-064686150.6 KB
Sign

Get Envelope by ID

The Get Envelope by ID endpoint retrieves the details of a single envelope using its UUIDv4 identifier.

This endpoint is useful for monitoring the progress of an envelope, retrieving specific envelope information as part of API call chaining, or displaying envelope details within your internal system.

get/sign/envelopes/{envelopeID}

Path parameters

envelopeIDstring uuid required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Response

The GET Envelope by ID endpoint returns a JSON object with the envelope's data

IDstring uuid

A unique UUIDv4 string that identifies the envelope in the Nitro system.

createdAtstring date-time

UTC timestamp indicating when the envelope was created.

lastModifiedAtstring date-time

UTC timestamp indicating the last time the envelope was updated. Matches createdAt at the time of creation.

namestring

The name of the envelope.

status'drafted' | 'sent' | 'processing' | 'sealed' | 'rejected' | 'cancelled' | 'deleted'

The internal status of the envelope. Defaults to drafted on creation.

mode'sequential' | 'parallel'

Signing mode for the envelope.