---
title: "Get the envelope under review"
method: GET
path: "/api/review/envelope"
tags: ["review"]
---

# Get the envelope under review

`GET /api/review/envelope`

Returns the full envelope graph for the token's envelope, plus a short-lived signed `documentUrl` for the renderable PDF (the converted artifact when one exists, else the original only when it is a PDF; null when nothing renderable is stored) and a curated `detection` summary (parties + matching) derived from the latest completed detection run, or null when detection never completed. Requires a read-capable token.

## Response `200`

The envelope graph with review extras

- object
  - `envelope` object, required
    - `id` string, required
    - `organizationId` string, required
    - `teamId` string, nullable, required
    - `templateId` string, nullable, required
    - `templateContentHash` string, nullable, required
    - `status` 'draft' | 'detecting' | 'review' | 'in_progress' | 'completed' | 'declined' | 'voided' | 'expired', required
    - `detectionStatus` 'none' | 'running' | 'succeeded' | 'failed', required
    - `version` integer, required
    - `originalFilename` string, nullable, required
    - `displayName` string, nullable, required
    - `sourceFormat` string, nullable, required
    - `contentHash` string, nullable, required
    - `sizeBytes` number, nullable, required
    - `deliveryMode` string, required
    - `legalFramework` string, nullable, required
    - `consumerDisclosure` boolean, required
    - `expiresAt` string, date-time, nullable, required
    - `scheduledSendAt` string, date-time, nullable, required
    - `reminderPolicy` unknown
    - `sentAt` string, date-time, nullable, required
    - `completedAt` string, date-time, nullable, required
    - `declinedAt` string, date-time, nullable, required
    - `voidedAt` string, date-time, nullable, required
    - `expiredAt` string, date-time, nullable, required
    - `metadata` unknown
    - `senderUserId` string, nullable
    - `senderName` string, nullable
    - `senderEmail` string, nullable
    - `detectedParties` unknown
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `participants` object[], required
    - `id` string, required
    - `envelopeId` string, required
    - `organizationId` string, required
    - `orderIndex` integer, required
    - `name` string, required
    - `email` string, required
    - `company` string, nullable
    - `title` string, nullable
    - `status` 'pending' | 'signed' | 'declined', required
    - `detectedPartyIndex` integer, nullable
    - `consentedAt` string, date-time, nullable, required
    - `signedAt` string, date-time, nullable, required
    - `declinedAt` string, date-time, nullable, required
    - `declineReason` string, nullable, required
    - `lastViewedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `fields` object[], required
    - `id` string, required
    - `envelopeId` string, required
    - `organizationId` string, required
    - `participantId` string, nullable, required
    - `partyIndex` integer, nullable
    - `type` 'signature' | 'initials' | 'date' | 'text' | 'checkbox', required
    - `page` integer, required
    - `x` number, required
    - `y` number, required
    - `width` number, required
    - `height` number, required
    - `label` string, nullable, required
    - `required` boolean, required
    - `source` 'detected' | 'manual' | 'template', required
    - `prefillValue` string, nullable, required
    - `autoSource` 'signed_date' | 'participant_name' | 'participant_email' | 'participant_company' | 'participant_title' | 'sender_org_name' | 'null', nullable, required
    - `proposedAutoSource` 'signed_date' | 'participant_name' | 'participant_email' | 'participant_company' | 'participant_title' | 'sender_org_name' | 'null', nullable, required
    - `value` string, nullable, required
    - `filledAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `documentUrl` string, uri, nullable, required
  - `detection` object, nullable, required
    - `parties` object[], required
      - `name` string, required
      - `description` string, nullable, required
      - `signerName` string, nullable
      - `company` string, nullable
      - `title` string, nullable
    - `senderPartyIndex` integer, nullable, required
    - `matching` object, required
      - `matches` object[], required
        - `partyIndex` integer, required
        - `participantId` string, nullable, required
      - `ambiguous` boolean, required
      - `assignedFieldCount` integer, required
      - `unassignedFieldCount` integer, required
  - `effectiveSender` union, required
    - object
      - `kind` 'user', required
      - `userId` string, required
      - `name` string, required
      - `email` string, email, required
    - object
      - `kind` 'workspace', required
      - `name` string, required
      - `email` unknown, required

## Other responses

- `401` — Missing or invalid review token
- `403` — Token lacks read capability
- `404` — The token's envelope no longer exists

---

[API](https://skmtc.net/atlaswork/apis/atlas-api.md) · [All operations](https://skmtc.net/atlaswork/apis/atlas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlaswork/atlas-api/versions/a8a1e7479c90/schema)