---
title: "Get the envelope as seen by the authenticated signer"
method: GET
path: "/api/signer/envelope"
tags: ["signer"]
---

# Get the envelope as seen by the authenticated signer

`GET /api/signer/envelope`

Party-scoped read: returns the envelope summary, the signer's own participant record and fields, position/progress slots for every participant (no names or emails), and a short-lived `documentUrl`. For a participant whose turn has not arrived, `fields` is empty and `documentUrl` is null. Records a throttled `participant.viewed` event.

## Response `200`

The signer-scoped envelope view

- object
  - `envelope` object, required
    - `id` string, required
    - `status` 'draft' | 'detecting' | 'review' | 'in_progress' | 'completed' | 'declined' | 'voided' | 'expired', required
    - `detectionStatus` 'none' | 'running' | 'succeeded' | 'failed', required
    - `version` integer, required
    - `legalFramework` string, nullable, required
    - `consumerDisclosure` boolean, required
    - `originalFilename` string, nullable, required
    - `displayName` string, nullable, required
    - `expiresAt` string, date-time, nullable, required
  - `me` 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
  - `participants` object[], required
    - `orderIndex` integer, required
    - `status` 'pending' | 'signed' | 'declined', 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
    - `value` string, nullable, required
    - `filledAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `completedFields` 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
    - `value` string, nullable, required
    - `filledAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `isMyTurn` boolean, required
  - `senderName` string, nullable, required
  - `senderEmail` string, nullable, required
  - `branding` object, required
    - `displayName` string, required
    - `logoUrl` string, uri, nullable, required
    - `accentColor` string, required
  - `documentUrl` string, uri, nullable, required

## Other responses

- `401` — Missing, invalid, expired, or reissued signing link
- `404` — The link's envelope or participant 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)