---
title: "List envelopes (cursor pagination)"
method: GET
path: "/api/v1/envelopes"
tags: ["Envelopes"]
---

# List envelopes (cursor pagination)

`GET /api/v1/envelopes`

## Request

- Base URL: `https://swiftsign.ca`
- URL: `https://swiftsign.ca/api/v1/envelopes`
- Auth: HTTP bearer

## Query parameters

- `cursor` string: Opaque cursor from next_cursor.
- `limit` integer: Default 25, max 100.
- `status` 'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'VOIDED'
- `mode` 'live' | 'test': Defaults to the key’s mode.
- `created_after` string: ISO 8601 lower bound.
- `created_before` string: ISO 8601 upper bound.
- `recipient_email` string, email

## Response `200`

A page of envelopes.

- EnvelopeList
  - `data` EnvelopeListItem[], required
    - `id` string, required
    - `subject` string, required
    - `status` 'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'VOIDED', required
    - `livemode` boolean, required
    - `createdAt` string, required
    - `recipientCount` integer, required
  - `has_more` boolean, required
  - `next_cursor` string, nullable, required

## Other responses

- `401`: Missing or invalid API key.
- `403`: API key lacks the envelopes:read scope.

---

[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)