---
title: "List signature envelopes"
method: GET
path: "/api/v1/rest/firme/envelopes"
tags: ["Signatures"]
---

# List signature envelopes

`GET /api/v1/rest/firme/envelopes`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/firme/envelopes`
- Auth: HTTP bearer

What is out for signature, and what has come back. Filter by status: `sent` and `partially_signed` are the ones still waiting on somebody. Each row says who has signed and who has not, which is usually the actual question.

**Examples**

- What is still waiting to be signed?
  `GET /api/v1/rest/firme/envelopes?open_only=true`
- Show me the completed ones
  `GET /api/v1/rest/firme/envelopes?status=completed`

## Query parameters

- `status` 'draft' | 'sent' | 'partially_signed' | 'completed' | 'declined' | 'expired' | 'voided'
- `open_only` boolean
- `query` string
- `limit` integer
- `cursor` string

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)
