---
title: "Gets envelope statuses for a set of envelopes."
method: PUT
path: "/v2.1/accounts/{accountId}/envelopes/status"
tags: ["Envelopes"]
---

# Gets envelope statuses for a set of envelopes.

`PUT /v2.1/accounts/{accountId}/envelopes/status`

Retrieves envelope statuses for a set of envelopes. `Envelopes: listStatus` has both a `GET` and a `PUT` implementation:
* `PUT /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information.
* `GET /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a list of envelope IDs in a query string.

<ds-inlinemessage>
To search for envelopes using a broad range of filters, use
<a href="/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/">Envelopes: listStatusChanges</a>
instead of this method.
</ds-inlinemessage>

You must specify exactly one of the following query parameters:

| Parameter         | Description                                                                      |
| :---------------- | :------------------------------------------------------------------------------- |
| `from_date`       | a valid UTC DateTime:  `2016-01-01`                                              |
| `envelope_ids`    | <ul><li>For the <code>GET</code> implementation of this method, include the envelope IDs in a comma-separated list. </li><li>For the <code>PUT</code> version of this method, you should use the <code>request_body</code> value for this parameter and include the list of envelope IDs in the request body.</li></ul>    |
| `transaction_ids` | A comma-separated list of transaction IDs<br>or the special value <code>request_body</code> |

When you use the special value `request_body`, the request body looks like this:

```
{
  "envelopeIds": [
    "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15",
    "8e26040d-xxxx-xxxx-xxxx-1e29b924d237",
    "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95"
  ]
}
```

<ds-inlinemessage kind="warning">
Omitting the request body altogether causes the endpoint to return an error.
The request body must be at least <code>{}</code>.
</ds-inlinemessage>

### Related topics

- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)
- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)

## Path parameters

- `accountId` string, required

## Query parameters

- `ac_status` string
- `block` string
- `count` string
- `email` string
- `envelope_ids` string
- `from_date` string
- `from_to_status` string
- `start_position` string
- `status` string
- `to_date` string
- `transaction_ids` string
- `user_name` string

## Request body

- EnvelopeIdsRequest — Lists of envelope and transaction IDs to use in the results. If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value `request_body`: - `envelope_ids=request_body` - `transaction_ids=request_body`
  - `envelopeIds` string[] — A comma-separated list of envelope IDs to include in the results.
  - `transactionIds` string[] — A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days.

## Response `200`

Successful response.

## Other responses

- `400` — Error encountered.

---

[API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/revisions/77f1998c313d/schema)