> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlaswork.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the envelope under review

> 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.



## OpenAPI

````yaml /openapi.json get /api/review/envelope
openapi: 3.0.0
info:
  title: Atlas API
  version: 0.0.0
servers:
  - url: https://api.atlaswork.ai
security: []
paths:
  /api/review/envelope:
    get:
      tags:
        - review
      summary: Get the envelope under review
      description: >-
        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.
      responses:
        '200':
          description: The envelope graph with review extras
          content:
            application/json:
              schema:
                type: object
                properties:
                  envelope:
                    type: object
                    properties:
                      id:
                        type: string
                      organizationId:
                        type: string
                      teamId:
                        type: string
                      templateId:
                        type: string
                        nullable: true
                      templateContentHash:
                        type: string
                        nullable: true
                      status:
                        type: string
                        enum:
                          - draft
                          - detecting
                          - review
                          - in_progress
                          - completed
                          - declined
                          - voided
                          - expired
                      detectionStatus:
                        type: string
                        enum:
                          - none
                          - running
                          - succeeded
                          - failed
                      version:
                        type: integer
                      originalFilename:
                        type: string
                        nullable: true
                      displayName:
                        type: string
                        nullable: true
                      sourceFormat:
                        type: string
                        nullable: true
                      contentHash:
                        type: string
                        nullable: true
                      sizeBytes:
                        type: number
                        nullable: true
                      deliveryMode:
                        type: string
                      legalFramework:
                        type: string
                        nullable: true
                      consumerDisclosure:
                        type: boolean
                      expiresAt:
                        type: string
                        nullable: true
                        format: date-time
                      scheduledSendAt:
                        type: string
                        nullable: true
                        format: date-time
                      reminderPolicy:
                        nullable: true
                      sentAt:
                        type: string
                        nullable: true
                        format: date-time
                      completedAt:
                        type: string
                        nullable: true
                        format: date-time
                      declinedAt:
                        type: string
                        nullable: true
                        format: date-time
                      voidedAt:
                        type: string
                        nullable: true
                        format: date-time
                      expiredAt:
                        type: string
                        nullable: true
                        format: date-time
                      metadata:
                        nullable: true
                      senderUserId:
                        type: string
                        nullable: true
                      senderName:
                        type: string
                        nullable: true
                      senderEmail:
                        type: string
                        nullable: true
                      detectedParties:
                        nullable: true
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - organizationId
                      - teamId
                      - templateId
                      - templateContentHash
                      - status
                      - detectionStatus
                      - version
                      - originalFilename
                      - displayName
                      - sourceFormat
                      - contentHash
                      - sizeBytes
                      - deliveryMode
                      - legalFramework
                      - consumerDisclosure
                      - expiresAt
                      - scheduledSendAt
                      - sentAt
                      - completedAt
                      - declinedAt
                      - voidedAt
                      - expiredAt
                      - createdAt
                      - updatedAt
                  participants:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        envelopeId:
                          type: string
                        organizationId:
                          type: string
                        orderIndex:
                          type: integer
                        name:
                          type: string
                        email:
                          type: string
                        company:
                          type: string
                          nullable: true
                        title:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - pending
                            - signed
                            - declined
                        detectedPartyIndex:
                          type: integer
                          nullable: true
                        consentedAt:
                          type: string
                          nullable: true
                          format: date-time
                        signedAt:
                          type: string
                          nullable: true
                          format: date-time
                        declinedAt:
                          type: string
                          nullable: true
                          format: date-time
                        declineReason:
                          type: string
                          nullable: true
                        lastViewedAt:
                          type: string
                          nullable: true
                          format: date-time
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - envelopeId
                        - organizationId
                        - orderIndex
                        - name
                        - email
                        - status
                        - consentedAt
                        - signedAt
                        - declinedAt
                        - declineReason
                        - lastViewedAt
                        - createdAt
                        - updatedAt
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        envelopeId:
                          type: string
                        organizationId:
                          type: string
                        participantId:
                          type: string
                          nullable: true
                        partyIndex:
                          type: integer
                          nullable: true
                        type:
                          type: string
                          enum:
                            - signature
                            - initials
                            - date
                            - text
                            - checkbox
                        page:
                          type: integer
                        x:
                          type: number
                        'y':
                          type: number
                        width:
                          type: number
                        height:
                          type: number
                        label:
                          type: string
                          nullable: true
                        required:
                          type: boolean
                        source:
                          type: string
                          enum:
                            - detected
                            - manual
                            - template
                        prefillValue:
                          type: string
                          nullable: true
                        locked:
                          type: boolean
                        autoSource:
                          type: string
                          nullable: true
                          enum:
                            - signed_date
                            - participant_name
                            - participant_email
                            - participant_company
                            - participant_title
                            - sender_org_name
                            - null
                        proposedAutoSource:
                          type: string
                          nullable: true
                          enum:
                            - signed_date
                            - participant_name
                            - participant_email
                            - participant_company
                            - participant_title
                            - sender_org_name
                            - null
                        value:
                          type: string
                          nullable: true
                        filledAt:
                          type: string
                          nullable: true
                          format: date-time
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - envelopeId
                        - organizationId
                        - participantId
                        - type
                        - page
                        - x
                        - 'y'
                        - width
                        - height
                        - label
                        - required
                        - source
                        - prefillValue
                        - locked
                        - autoSource
                        - proposedAutoSource
                        - value
                        - filledAt
                        - createdAt
                        - updatedAt
                  documentUrl:
                    type: string
                    nullable: true
                    format: uri
                  detection:
                    type: object
                    nullable: true
                    properties:
                      parties:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            description:
                              type: string
                              nullable: true
                            signerName:
                              type: string
                              nullable: true
                            company:
                              type: string
                              nullable: true
                            title:
                              type: string
                              nullable: true
                          required:
                            - name
                            - description
                      senderPartyIndex:
                        type: integer
                        nullable: true
                      matching:
                        type: object
                        properties:
                          matches:
                            type: array
                            items:
                              type: object
                              properties:
                                partyIndex:
                                  type: integer
                                participantId:
                                  type: string
                                  nullable: true
                              required:
                                - partyIndex
                                - participantId
                          ambiguous:
                            type: boolean
                          assignedFieldCount:
                            type: integer
                          unassignedFieldCount:
                            type: integer
                        required:
                          - matches
                          - ambiguous
                          - assignedFieldCount
                          - unassignedFieldCount
                    required:
                      - parties
                      - senderPartyIndex
                      - matching
                  sendPreflight:
                    type: object
                    properties:
                      credits:
                        type: object
                        properties:
                          balance:
                            type: integer
                            minimum: 0
                          required:
                            type: number
                            enum:
                              - 1
                          sufficient:
                            type: boolean
                        required:
                          - balance
                          - required
                          - sufficient
                      blockers:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - insufficient_credits
                            message:
                              type: string
                              minLength: 1
                          required:
                            - code
                            - message
                    required:
                      - credits
                      - blockers
                  effectiveSender:
                    oneOf:
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - user
                          userId:
                            type: string
                          name:
                            type: string
                            minLength: 1
                          email:
                            type: string
                            format: email
                        required:
                          - kind
                          - userId
                          - name
                          - email
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - workspace
                          name:
                            type: string
                            minLength: 1
                          email:
                            nullable: true
                        required:
                          - kind
                          - name
                          - email
                required:
                  - envelope
                  - participants
                  - fields
                  - documentUrl
                  - detection
                  - sendPreflight
                  - effectiveSender
        '401':
          description: Missing or invalid review token
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  details:
                    type: object
                    additionalProperties:
                      nullable: true
                required:
                  - code
                  - message
        '403':
          description: Token lacks read capability
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  details:
                    type: object
                    additionalProperties:
                      nullable: true
                required:
                  - code
                  - message
        '404':
          description: The token's envelope no longer exists
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  details:
                    type: object
                    additionalProperties:
                      nullable: true
                required:
                  - code
                  - message
      security:
        - reviewToken: []
components:
  securitySchemes:
    reviewToken:
      type: http
      scheme: bearer
      description: >-
        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.

````