> For the complete documentation index, see [llms.txt](https://developers.docstudio.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.docstudio.com/api-reference/check-envelope-status.md).

# Check Envelope Status

This document contains details for the /api/v1/envelope/{envelopeUuid} endpoint, including headers, parameters, response fields, and status codes.

Use this endpoint when you already know the envelope UUID and need to retrieve latest status and details. Use `POST /api/v1/envelope/search` to filter envelopes. The current status of the retrieved envelope is returned in `envelope.status`.

### Endpoint

| Method | Endpoint                          |
| ------ | --------------------------------- |
| `GET`  | `/api/v1/envelope/{envelopeUuid}` |

### Headers

<table><thead><tr><th width="149">Header</th><th width="153">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>Authorization</code></td><td>Yes</td><td>Bearer authorization token</td></tr><tr><td><code>Mailbox</code></td><td>Yes</td><td>UUID of the mailbox used as the current mailbox context</td></tr></tbody></table>

### Path parameters

<table><thead><tr><th>Parameter</th><th width="104">Type</th><th width="120">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>envelopeUuid</code></td><td>UUID</td><td>Yes</td><td>UUID of the envelope to retrieve</td></tr></tbody></table>

### Request example

```http
GET /api/v1/envelope/89499ba2-287d-404c-87b0-342dc5b01b6a
Authorization: Bearer {token}
Mailbox: 9baec31c-e940-4894-b6d1-52033e1af66e
```

### Response

The endpoint returns `200 OK` with envelope, template, and scenario details.

```json
{
  "envelope": {
    "uuid": "89499ba2-287d-404c-87b0-342dc5b01b6a",
    "createdAt": "2026-08-27T13:02:46.796Z",
    "receivedAt": "2026-08-27T13:02:46.796Z",
    "sentAt": "2026-08-27T13:02:46.796Z",
    "status": "COMPLETED",
    "sender": {
      "mailboxUuid": "fdfde267-6558-40a9-93fd-e59529baef36",
      "mailboxName": "Sender mailbox",
      "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "accountName": "Sender account"
    },
    "deleted": false,
    "archived": false,
    "metadata": {
      "customerId": "ACME-1001"
    }
  },
  "template": {
    "uuid": "56cacd6a-ffe7-4b77-9c0c-f928d9a18cb5",
    "name": "Sales agreement",
    "version": "143a2a4b-325e-4c05-a4c1-52f44e21b745"
  },
  "scenario": null
}
```

#### Response fields

<table><thead><tr><th>Field</th><th width="225">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>envelope</code></td><td>object</td><td>Envelope details</td></tr><tr><td><code>template</code></td><td>object</td><td>Template details</td></tr><tr><td><code>scenario</code></td><td>object or <code>null</code></td><td>Scenario details when available</td></tr></tbody></table>

#### Envelope fields

<table><thead><tr><th>Field</th><th width="169">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>uuid</code></td><td>UUID</td><td>Envelope UUID</td></tr><tr><td><code>createdAt</code></td><td>datetime</td><td>Envelope creation time</td></tr><tr><td><code>receivedAt</code></td><td>datetime</td><td>Envelope receipt time</td></tr><tr><td><code>sentAt</code></td><td>datetime</td><td>Envelope send time</td></tr><tr><td><code>status</code></td><td>string</td><td>Current envelope status</td></tr><tr><td><code>sender</code></td><td>object</td><td>Sender mailbox and account details</td></tr><tr><td><code>deleted</code></td><td>boolean</td><td>Whether the envelope is deleted</td></tr><tr><td><code>archived</code></td><td>boolean</td><td>Whether the envelope is archived</td></tr><tr><td><code>metadata</code></td><td>object</td><td>Custom envelope metadata</td></tr></tbody></table>

#### Sender fields

| Field         | Type   | Description         |
| ------------- | ------ | ------------------- |
| `mailboxUuid` | UUID   | Sender mailbox UUID |
| `mailboxName` | string | Sender mailbox name |
| `accountUuid` | UUID   | Sender account UUID |
| `accountName` | string | Sender account name |

#### Template fields

| Field     | Type   | Description           |
| --------- | ------ | --------------------- |
| `uuid`    | UUID   | Template UUID         |
| `name`    | string | Template name         |
| `version` | UUID   | Template version UUID |

### Status codes

| Code  | Description                                      |
| ----- | ------------------------------------------------ |
| `200` | Envelope retrieved successfully                  |
| `401` | Missing, invalid, or expired authorization token |
| `403` | No access to the specified mailbox               |
| `404` | Envelope or mailbox not found                    |

### Related topics

* [Authorization](/api-reference/authorization.md)
* [Send Envelope](/api-reference/send-envelope.md)
* [Error handling and API error codes](/error-codes/error-handling-and-api-error-codes.md)