---
title: "Get Share"
method: GET
path: "/api/shares/{token}"
tags: ["shares"]
---

# Get Share

`GET /api/shares/{token}`

## Request

- Base URL: `https://api.retirementlab.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.retirementlab.app/api/shares/{token}`
- Auth: none declared

## Path parameters

- `token` string, required

## Response `200`

Successful Response

- ShareDataResponse
  - `token` string, required
  - `config_name` string, required
  - `config_snapshot` object, required
  - `result_snapshot` object, required
  - `created_at` string, required
  - `label` string
  - `notes` string
  - `cohort_index` CohortIndexEntry[]
    - `start_year` integer, required
    - `scenario_index` integer
    - `is_failure` boolean, required
    - `depletion_year_index` integer
    - `yearly_ending_balances` number[]
  - `currency_context` object
  - `compute_provenance` ComputeProvenanceResponse
    - `contract_version` integer, required
    - `available` boolean, required
    - `state` 'legacy'
    - `result_origin` 'computed' | 'copied'
    - `api_deploy_sha` string
    - `worker_deploy_sha` string
    - `engine_contract_version` string
    - `aggregate_result_schema_version` integer
    - `artifact_materializer_version` string
    - `artifact_schema_versions` object
    - `python_version` string
    - `numpy_version` string
    - `platform` string
    - `architecture` string
    - `run_kind` string
    - `worker_attempt_number` integer
  - `assumptions_version` string
  - `assumptions_version_state` 'declared' | 'legacy_unverified'

## Other responses

- `422`: Validation Error

---

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