---
title: "Retrieve an envelope"
method: GET
path: "/api/v1/envelopes/{id}"
tags: ["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

- `id` string, required

## Response `200`

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

- Envelope
  - `id` string, required
  - `subject` string, required
  - `message` string, nullable, required
  - `status` 'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'VOIDED', required
  - `livemode` boolean, required
  - `createdAt` string, required
  - `documents` Document[], required
    - `id` string, required
    - `name` string, required
    - `pageCount` integer, required
    - `order` integer, required
  - `recipients` Recipient[], required
    - `id` string, required
    - `name` string, required
    - `email` string, email, required
    - `role` 'SIGNER' | 'CC', required
    - `routingOrder` integer, required
    - `status` string, required

## Other responses

- `401`: Missing or invalid API key.
- `404`: Envelope not found.

---

[API](https://skmtc.dev/swiftsign/apis/swiftsign-api.md) · [All operations](https://skmtc.dev/swiftsign/apis/swiftsign-api/llms.txt) · [OpenAPI document](https://skmtc.dev/swiftsign/apis/swiftsign-api/revisions/0dde3d617126?raw)