Get an envelope
curl --request GET \
--url https://api.atlaswork.ai/api/v1/envelopes/{id} \
--header 'Authorization: Bearer <token>'{
"envelope": {
"id": "<string>",
"organizationId": "<string>",
"version": 123,
"originalFilename": "<string>",
"sourceFormat": "<string>",
"contentHash": "<string>",
"sizeBytes": 123,
"deliveryMode": "<string>",
"legalFramework": "<string>",
"consumerDisclosure": true,
"expiresAt": "2023-11-07T05:31:56Z",
"scheduledSendAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"expiredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reminderPolicy": null,
"metadata": null
},
"participants": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"orderIndex": 123,
"name": "<string>",
"email": "<string>",
"consentedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"lastViewedAt": "2023-11-07T05:31:56Z",
"lastIpAddress": "<string>",
"lastUserAgent": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"fields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}envelopes
Get an envelope
Returns the full envelope graph (envelope + participants + fields). Envelopes outside the API key’s organization yield 404.
GET
/
api
/
v1
/
envelopes
/
{id}
Get an envelope
curl --request GET \
--url https://api.atlaswork.ai/api/v1/envelopes/{id} \
--header 'Authorization: Bearer <token>'{
"envelope": {
"id": "<string>",
"organizationId": "<string>",
"version": 123,
"originalFilename": "<string>",
"sourceFormat": "<string>",
"contentHash": "<string>",
"sizeBytes": 123,
"deliveryMode": "<string>",
"legalFramework": "<string>",
"consumerDisclosure": true,
"expiresAt": "2023-11-07T05:31:56Z",
"scheduledSendAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"expiredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reminderPolicy": null,
"metadata": null
},
"participants": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"orderIndex": 123,
"name": "<string>",
"email": "<string>",
"consentedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"lastViewedAt": "2023-11-07T05:31:56Z",
"lastIpAddress": "<string>",
"lastUserAgent": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"fields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Organization API key (format atlas_sk_...), passed as a bearer token or the x-api-key header. Created and revoked in the dashboard (Better Auth api-key plugin); shown in full only once and stored hashed.
Path Parameters
Envelope id
Minimum string length:
1⌘I