Get the e-signature envelope

GET

/v1/runs/:id/envelope

GET

/v1/runs/:id/envelope

$ curl https://api.cloudraker.com/v1/runs/id/envelope \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "envelopeId": "env_9f8b7c6d-1234-4a56-b789-0cdef1234567",
3   "status": "in_progress",
4   "createdAt": "2024-06-10T09:15:00Z",
5   "updatedAt": "2024-06-12T14:45:30Z",
6   "signers": [
7     {
8       "signerId": "signer_01a2b3c4d5e6f7g8h9i0",
9       "name": "Alice Johnson",
10       "email": "[email protected]",
11       "status": "signed",
12       "emailVerifiedAt": "2024-06-10T10:00:00Z",
13       "signedAt": "2024-06-11T08:30:00Z"
14     },
15     {
16       "signerId": "signer_0a9b8c7d6e5f4g3h2i1j",
17       "name": "Bob Smith",
18       "email": "[email protected]",
19       "status": "pending",
20       "emailVerifiedAt": "2024-06-11T09:15:00Z",
21       "signedAt": null
22     },
23     {
24       "signerId": "signer_1234567890abcdef1234",
25       "name": "Carol Lee",
26       "email": "[email protected]",
27       "status": "declined",
28       "emailVerifiedAt": "2024-06-10T11:45:00Z",
29       "signedAt": null
30     }
31   ],
32   "events": [
33     {
34       "eventId": "evt_001",
35       "timestamp": "2024-06-10T09:15:00Z",
36       "type": "envelope_created",
37       "description": "Envelope created by sender"
38     },
39     {
40       "eventId": "evt_002",
41       "timestamp": "2024-06-10T10:00:00Z",
42       "type": "email_verified",
43       "signerId": "signer_01a2b3c4d5e6f7g8h9i0",
44       "description": "Alice Johnson verified email"
45     },
46     {
47       "eventId": "evt_003",
48       "timestamp": "2024-06-11T08:30:00Z",
49       "type": "signed",
50       "signerId": "signer_01a2b3c4d5e6f7g8h9i0",
51       "description": "Alice Johnson signed the document"
52     },
53     {
54       "eventId": "evt_004",
55       "timestamp": "2024-06-11T09:15:00Z",
56       "type": "email_verified",
57       "signerId": "signer_0a9b8c7d6e5f4g3h2i1j",
58       "description": "Bob Smith verified email"
59     },
60     {
61       "eventId": "evt_005",
62       "timestamp": "2024-06-12T14:00:00Z",
63       "type": "declined",
64       "signerId": "signer_1234567890abcdef1234",
65       "description": "Carol Lee declined to sign"
66     }
67   ]
68 }

The sender’s view of a sign run — envelope status, the signer roster with per-signer state, 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.

Learn more: E-signature guide

The sender's view of a `sign` run — envelope status, the signer roster with per-signer state, 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`. <Note> 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). </Note> **Learn more:** [E-signature guide](https://docs.cloudraker.com/capabilities/sign)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

Get the e-signature envelope

Errors

429

Too Many Requests Error