---
title: "List envelopes"
method: GET
path: "/envelopes"
tags: ["envelope"]
---

# List envelopes

`GET /envelopes`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/envelopes`
- Auth: HTTP bearer

Use this to find envelopes ("the NDA I sent Dana") or what waits for the person's signature. Newest first; waiting_for_me counts those whose next signature is theirs, with the page to sign them; no tool signs.

## Query parameters

- `document_id` string: One document's envelopes.
- `waiting_for_me` boolean: Only those waiting for the person you work for to sign.
- `status` 'draft' | 'sent' | 'completed' | 'declined' | 'voided' | 'expired'
- `query` string: A title, or a signer's name or email: "Dana", "NDA".
- `limit` integer
- `cursor` string: The next_cursor of the last call, for the page after it.

## Response `200`

The result.

- object
  - `items` object[], required
    - `id` string, required
    - `document_id` string, required
    - `version_id` string, required
    - `title` string, required
    - `message` string, nullable, required
    - `status` 'draft' | 'sent' | 'completed' | 'declined' | 'voided' | 'expired', required
    - `ordered` boolean, required
    - `pages` integer, required
    - `signature_page` boolean, required
    - `signers` object[], required
      - `id` string, required
      - `name` string, required
      - `email` string, required
      - `position` integer, required
      - `order` integer, required
      - `status` 'waiting' | 'notified' | 'viewed' | 'signed' | 'declined' | 'change_requested', required
      - `is_me` boolean, required
      - `auth` 'link' | 'code', required
      - `intent` 'sign' | 'acknowledge', required
      - `viewed_at` string, date-time, nullable, required
      - `signed_at` string, date-time, nullable, required
      - `declined_at` string, date-time, nullable, required
      - `decline_reason` string, nullable, required
      - `change_request` object, nullable, required
        - `reason` 'wrong_entity' | 'wrong_signatory' | 'wrong_terms' | 'other', required
        - `at` string, date-time, required
        - `closed_at` string, date-time, nullable, required
        - `reply` string, nullable, required
        - `untrusted_content` object, required
          - `note` string, nullable, required
          - `signatory` object, nullable, required
            - `name` string, required
            - `email` string, required
            - `title` string, nullable, required
      - `same_origin_as` object[], required
        - `name` string, required
        - `by` 'ip_address' | 'browser_within_a_minute', required
      - `replaced` object[], required
        - `name` string, required
        - `email` string, required
        - `reason` string, required
        - `at` string, date-time, required
    - `fields` object[], required
      - `id` string, required
      - `signer_id` string, nullable, required
      - `kind` 'signature' | 'initials' | 'date' | 'name' | 'text', required
      - `page` integer, required
      - `x` number, required
      - `y` number, required
      - `width` number, required
      - `height` number, required
      - `required` boolean, required
      - `filled` boolean, required
      - `proposed` boolean, required
      - `source` 'tag' | 'form' | 'signature_line' | 'template', nullable, required
      - `group` string, nullable, required
      - `match` 'tag' | 'name' | 'company' | 'email_domain' | 'decision', nullable, required
      - `decision` object, nullable, required
        - `model` string, required
        - `probability` number, required
        - `id` string, nullable, required
    - `url` string, required
    - `code` string, nullable, required
    - `disputed` object, nullable, required
      - `by` string, required
      - `at` string, date-time, required
      - `note` string, nullable, required
      - `resolved_at` string, date-time, nullable, required
      - `resolution` string, nullable, required
    - `result_sha256` string, nullable, required
    - `created_at` string, date-time, required
    - `sent_at` string, date-time, nullable, required
    - `completed_at` string, date-time, nullable, required
    - `voided_at` string, date-time, nullable, required
    - `expires_at` string, date-time, nullable, required
    - `reminded_at` string, date-time, nullable, required
    - `reminders` object, required
      - `every_days` integer, nullable, required
      - `next_at` string, date-time, nullable, required
    - `needs_review` boolean, required
    - `exclusion_override` string, nullable, required
    - `hold` 'funding', nullable, required
    - `safe` object, nullable, required
      - `id` string, required
      - `investor` string, required
      - `amount` string, required
  - `next_cursor` string, nullable, required
  - `waiting_for_me` object, nullable, required
    - `count` integer, required
    - `url` string, required

## Other responses

- `default`: An RFC 9457 problem.

---

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