List envelopes
curl --request GET \
--url https://api.atlaswork.ai/api/v1/envelopes \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atlaswork.ai/api/v1/envelopes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/v1/envelopes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"templateId": "<string>",
"templateContentHash": "<string>",
"status": "draft",
"detectionStatus": "none",
"version": 123,
"originalFilename": "<string>",
"displayName": "<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",
"teamName": "<string>",
"participantCount": 1,
"signedCount": 1,
"latestActivity": {
"label": "<string>",
"occurredAt": "2023-11-07T05:31:56Z"
},
"signers": [
{
"participantId": "<string>",
"name": "<string>",
"status": "pending",
"declineReason": "<string>",
"lastEventLabel": "<string>",
"lastEventAt": "2023-11-07T05:31:56Z",
"lastRemindedAt": "2023-11-07T05:31:56Z",
"nextReminderAt": "2023-11-07T05:31:56Z"
}
],
"attention": [
"delivery_failed"
],
"reminderPolicy": null,
"metadata": null,
"senderUserId": "<string>",
"senderName": "<string>",
"senderEmail": "<string>",
"detectedParties": null
}
],
"nextCursor": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": {}
}envelopes
List envelopes
Cursor-paginated list of the organization’s envelopes, ordered by createdAt descending. Pass nextCursor from the previous page as cursor; limit is capped at 100 (default 50). Filter by lifecycle status with status (one or more statuses, comma-separated), and by name with q (case-insensitive substring of the display name or the original filename).
GET
/
api
/
v1
/
envelopes
List envelopes
curl --request GET \
--url https://api.atlaswork.ai/api/v1/envelopes \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atlaswork.ai/api/v1/envelopes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/v1/envelopes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"templateId": "<string>",
"templateContentHash": "<string>",
"status": "draft",
"detectionStatus": "none",
"version": 123,
"originalFilename": "<string>",
"displayName": "<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",
"teamName": "<string>",
"participantCount": 1,
"signedCount": 1,
"latestActivity": {
"label": "<string>",
"occurredAt": "2023-11-07T05:31:56Z"
},
"signers": [
{
"participantId": "<string>",
"name": "<string>",
"status": "pending",
"declineReason": "<string>",
"lastEventLabel": "<string>",
"lastEventAt": "2023-11-07T05:31:56Z",
"lastRemindedAt": "2023-11-07T05:31:56Z",
"nextReminderAt": "2023-11-07T05:31:56Z"
}
],
"attention": [
"delivery_failed"
],
"reminderPolicy": null,
"metadata": null,
"senderUserId": "<string>",
"senderName": "<string>",
"senderEmail": "<string>",
"detectedParties": null
}
],
"nextCursor": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": {}
}Authorizations
apiKeyoauthJwt
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.
Query Parameters
Required range:
1 <= x <= 100Maximum string length:
200Available options:
attention, waiting, drafts, completed, all Required string length:
1 - 200Required string length:
1 - 200Required string length:
1 - 200Available options:
created, sent, completed, activity, name, urgency