> ## 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 as seen by the authenticated signer

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



## OpenAPI

````yaml /openapi.json get /api/signer/envelope
openapi: 3.0.0
info:
  title: Atlas API
  version: 0.0.0
servers:
  - url: https://api.atlaswork.ai
security: []
paths:
  /api/signer/envelope:
    get:
      tags:
        - signer
      summary: Get the envelope as seen by the authenticated signer
      description: >-
        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.
      responses:
        '200':
          description: The signer-scoped envelope view
          content:
            application/json:
              schema:
                type: object
                properties:
                  envelope:
                    type: object
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                        enum:
                          - draft
                          - detecting
                          - review
                          - in_progress
                          - completed
                          - declined
                          - voided
                          - expired
                      detectionStatus:
                        type: string
                        enum:
                          - none
                          - running
                          - succeeded
                          - failed
                      version:
                        type: integer
                      legalFramework:
                        type: string
                        nullable: true
                      consumerDisclosure:
                        type: boolean
                      originalFilename:
                        type: string
                        nullable: true
                      displayName:
                        type: string
                        nullable: true
                      expiresAt:
                        type: string
                        nullable: true
                        format: date-time
                    required:
                      - id
                      - status
                      - detectionStatus
                      - version
                      - legalFramework
                      - consumerDisclosure
                      - originalFilename
                      - displayName
                      - expiresAt
                  me:
                    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
                  participants:
                    type: array
                    items:
                      type: object
                      properties:
                        orderIndex:
                          type: integer
                        status:
                          type: string
                          enum:
                            - pending
                            - signed
                            - declined
                      required:
                        - orderIndex
                        - status
                  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
                        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
                        - value
                        - filledAt
                        - createdAt
                        - updatedAt
                  completedFields:
                    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
                        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
                        - value
                        - filledAt
                        - createdAt
                        - updatedAt
                  isMyTurn:
                    type: boolean
                  senderName:
                    type: string
                    nullable: true
                  senderEmail:
                    type: string
                    nullable: true
                  branding:
                    type: object
                    properties:
                      displayName:
                        type: string
                      logoUrl:
                        type: string
                        nullable: true
                        format: uri
                      logoWidth:
                        type: integer
                        nullable: true
                        minimum: 0
                        exclusiveMinimum: true
                      logoHeight:
                        type: integer
                        nullable: true
                        minimum: 0
                        exclusiveMinimum: true
                      accentColor:
                        type: string
                        pattern: ^#[0-9a-f]{6}$
                    required:
                      - displayName
                      - logoUrl
                      - accentColor
                  documentUrl:
                    type: string
                    nullable: true
                    format: uri
                required:
                  - envelope
                  - me
                  - participants
                  - fields
                  - completedFields
                  - isMyTurn
                  - senderName
                  - senderEmail
                  - branding
                  - documentUrl
        '401':
          description: Missing, invalid, expired, or reissued signing link
          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 link's envelope or participant 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:
        - signerToken: []
components:
  securitySchemes:
    signerToken:
      type: http
      scheme: bearer
      description: HMAC-signed envelope token, as a bearer token or a `token` query param.

````