---
title: "List Envelopes"
method: GET
path: "/envelopes"
tags: ["E-Signature"]
---

# List Envelopes

`GET /envelopes`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/envelopes`
- Auth: HTTP bearer

Envelopes in the organisation, newest first.

`source_type` + `source_id` is the join back to whatever produced the
envelope, so "has the quote I sent been signed" is one call rather than a
scan.

## Query parameters

- `status` string, nullable: `draft`, `sent`, `viewed`, `completed`, `voided`, `expired`.
- `source_type` string, nullable: What produced the envelope, e.g. `quote`.
- `source_id` string, nullable: The producing record's id.
- `page` integer
- `limit` integer

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseEnvelopeListPayload
  - `data` EnvelopeListPayload, required: A page of envelopes.
    - `items` unknown[]
      - unknown
    - `total` integer
    - `page` integer
    - `limit` integer
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

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