> This page is for Paperwork API, version v1 (default).
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.cloudraker.com/paperwork/v1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Get the e-signature envelope

GET https://api.cloudraker.com/v1/runs/{id}/envelope

The sender's view of a `sign` run — envelope status, the signer roster with per-signer state, any `cc` recipients, and the event trail.

Every sign response points here through `envelopeUrl`. Use it to answer "who still has to sign?": each `signers[]` entry carries its own `status`, `emailVerifiedAt` and `signedAt`.

This never contains signing links. Those are bearer capabilities held only by the signers themselves — to get one to a signer, use [POST /v1/runs/\{id}/signers/\{signerId}/resend](https://docs.cloudraker.com/api/cloud-raker-api/runs/resend-run-signer).

**Learn more:** [E-signature guide](https://docs.cloudraker.com/capabilities/sign)

Reference: https://docs.cloudraker.com/paperwork/api/runs/get-run-envelope

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

Get the e-signature envelope

- `envelope` (RunSignEnvelopeViewEnvelope, required)
- `signers` (list of RunSignEnvelopeViewSignersItems, required) — Ordered by signing position. Never carries a signing link.
- `events` (list of RunSignEnvelopeViewEventsItems, required)
- `cc` (list of RunSignEnvelopeViewCcItems, optional) — Informed-only recipients, emailed the sealed PDF on completion.

## Errors

### 429 Too Many Requests Error

Rate limited. The `/v1` API allows at least **67 requests per minute per organization** (about 1,000 requests per 15 minutes) — a guaranteed floor, enforced per edge location, so a geographically spread caller may get more. Wait for the `Retry-After` interval and retry — the error is `retryable`.

- `code` (enum, required)
  - Allowed values: `rate_limited`
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

## Types

### RunSignEnvelopeViewEnvelope

- `id` (string, required)
- `docName` (string, required)
- `docSha256` (string, required)
- `docSize` (double, required)
- `status` (enum, required)
  - Allowed values: `pending`, `finalizing`, `completed`, `failed`, `voided`
- `signatureMode` (string, required)
- `language` (enum, required)
  - Allowed values: `en`, `fr`
- `message` (string, required, nullable)
- `error` (string, required, nullable)
- `outputFileId` (string, required, nullable) — The signed PDF. Download it with `GET /v1/files/{id}`.
- `createdAt` (datetime, required)
- `completedAt` (datetime, required, nullable)
- `expiresAt` (datetime, required)

### RunSignEnvelopeViewSignersItems

- `id` (string, required)
- `name` (string, required)
- `email` (string, required)
- `position` (integer, required)
- `source` (enum, required)
  - Allowed values: `install`, `run`
- `status` (enum, required)
  - Allowed values: `pending`, `needs_input`, `waiting`, `signed`, `skipped`
- `emailVerifiedAt` (datetime, required, nullable)
- `signedAt` (datetime, required, nullable)
- `typedName` (string, required, nullable)
- `lastInvitedAt` (datetime, required, nullable)
- `routingOrder` (integer, optional)
- `signingGroup` (string, optional, nullable)
- `fieldIndex` (integer, optional)

### RunSignEnvelopeViewEventsItems

- `id` (string, required)
- `type` (string, required)
- `actor` (string, required) — Signer name, or `system`.
- `signerId` (string, required, nullable)
- `ip` (string, required, nullable)
- `occurredAt` (datetime, required)

### RunSignEnvelopeViewCcItems

- `name` (string, required)
- `email` (string, required)

## Examples

**Response**

```json
{
  "envelope": {
    "id": "string",
    "docName": "string",
    "docSha256": "string",
    "docSize": 1.1,
    "status": "pending",
    "signatureMode": "string",
    "language": "en",
    "message": "string",
    "error": "string",
    "outputFileId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "completedAt": "2024-01-15T09:30:00Z",
    "expiresAt": "2024-01-15T09:30:00Z"
  },
  "signers": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "position": 1,
      "source": "install",
      "status": "pending",
      "emailVerifiedAt": "2024-01-15T09:30:00Z",
      "signedAt": "2024-01-15T09:30:00Z",
      "typedName": "string",
      "lastInvitedAt": "2024-01-15T09:30:00Z",
      "routingOrder": 1,
      "signingGroup": "string",
      "fieldIndex": 1
    }
  ],
  "events": [
    {
      "id": "string",
      "type": "string",
      "actor": "string",
      "signerId": "string",
      "ip": "string",
      "occurredAt": "2024-01-15T09:30:00Z"
    }
  ],
  "cc": [
    {
      "name": "string",
      "email": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/runs/id/envelope"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/runs/id/envelope';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/v1/runs/id/envelope"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/v1/runs/id/envelope")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.cloudraker.com/v1/runs/id/envelope")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.cloudraker.com/v1/runs/id/envelope', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/runs/id/envelope");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/runs/id/envelope")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```