Envelopes

Retrieve an envelope

get/api/v1/envelopes/{id}

Request

  • Base URL: https://swiftsign.ca
  • URL: https://swiftsign.ca/api/v1/envelopes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

The envelope, including recipients, documents, and audit log.

idstring required
subjectstring required
messagestring nullable required
status'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'VOIDED' required
livemodeboolean required
createdAtstring required

Example response

{
  "id": "b8f1c0a2-3d4e-5f60-7182-93041a2b3c4d",
  "createdAt": "2026-03-14T16:02:11.000Z",
  "recipients": [
    {
      "status": "PENDING"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.