Skip to main content
GET
/
api
/
review
/
envelope
Get the envelope under review
curl --request GET \
  --url https://api.atlaswork.ai/api/review/envelope \
  --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",
      "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"
    }
  ],
  "documentUrl": "<string>",
  "detection": {
    "parties": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "matching": {
      "matches": [
        {
          "partyIndex": 123,
          "participantId": "<string>"
        }
      ],
      "ambiguous": true,
      "assignedFieldCount": 123,
      "unassignedFieldCount": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

HMAC-signed review token (minted into the envelope's review URL at creation), as a bearer token or a token query param. Capabilities are split per token: a read token grants view + draft editing, a send token grants the dispatch action only — so a forwarded review link can be shared read-only. Scoped to exactly one envelope; never valid as a signer credential.

Response

The envelope graph with review extras

​
envelope
object
required
​
participants
object[]
required
​
fields
object[]
required
​
documentUrl
string<uri> | null
required
​
detection
object
required