---
title: "Get Session"
method: GET
path: "/api/sessions/{session_id}"
tags: ["sessions"]
---

# Get Session

`GET /api/sessions/{session_id}`

## Request

- Base URL: `https://zsign.io` (the document declares no server; this is the origin it was published from)
- URL: `https://zsign.io/api/sessions/{session_id}`
- Auth: HTTP bearer

Get session details

## Path parameters

- `session_id` string, uuid, required

## Response `200`

Successful Response

- SessionResponse
  - `session_id` string, uuid, required
  - `revision_of` string, uuid, nullable
  - `superseded_by` string, uuid, nullable
  - `revision_draft_id` string, uuid, nullable
  - `status` 'pending' | 'in_progress' | 'completed' | 'voided' | 'declined' | 'expired' | 'cancelled' | 'deleted', required
  - `document_id` string, uuid, required
  - `document_type` 'template' | 'one_off', required
  - `expires_at` string, date-time, required
  - `recipients` RecipientResponse[], required
    - `recipient_id` string, uuid, required
    - `name` string, required
    - `email` string, required
    - `role` string, required
    - `signing_order` integer, required
    - `status` 'pending' | 'completed', required
    - `signing_url` string, nullable
    - `signed_at` string, date-time, nullable
    - `viewed_at` string, date-time, nullable
    - `can_remind` boolean
    - `change_request` ChangeRequestOut
      - `reason` string, nullable
      - `comments` ChangeRequestCommentOut[], required
        - `page` integer, required
        - `field_id` string, nullable
        - `field_label` string, nullable
        - `x` number, nullable
        - `y` number, nullable
        - `width` number, nullable
        - `height` number, nullable
        - `anchor_text` string, nullable
        - `text` string, required
        - `created_at` string, date-time, required
      - `at` string, date-time, nullable
  - `created_at` string, date-time, required
  - `progress` SessionProgress
    - `completed` integer, required
    - `total` integer, required
    - `percentage` integer, required
  - `void_reason` string, nullable
  - `voided_at` string, date-time, nullable
  - `document_name` string, required
  - `documents` EnvelopeDocumentOut[]
    - `id` string, required
    - `name` string, required
    - `filename` string, required
    - `page_start` integer, required
    - `page_count` integer, required
    - `position` integer, required
  - `activity` EnvelopeActivityEvent[]
    - `occurred_at` string, date-time, required
    - `event_type` 'sent' | 'reminded' | 'viewed' | 'signed' | 'voided' | 'declined' | 'changes_requested' | 'recipient_email_corrected', required
    - `actor_email` string, nullable
    - `actor_name` string, nullable
    - `recipient_id` string, uuid, nullable
    - `detail` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zsign/apis/zsign-api.md) · [All operations](https://skmtc.dev/zsign/apis/zsign-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zsign/apis/zsign-api/revisions/a674ac4137ba?raw)