Skip to main content
GET
/
api
/
v1
/
envelopes
List envelopes
curl --request GET \
  --url https://api.atlaswork.ai/api/v1/envelopes \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

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

cursor
string
limit
integer
Required range: 1 <= x <= 100

Response

One page of envelopes

items
object[]
required
nextCursor
string