---
title: "Claim Share"
method: POST
path: "/api/shares/{token}/claim"
tags: ["shares"]
---

# Claim Share

`POST /api/shares/{token}/claim`

## 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}/claim`
- Auth: HTTP bearer

Clone a shared scenario into the current user's session.

Deduplicates: if the user already claimed this token, returns the existing clone.

## Path parameters

- `token` string, required

## Response `200`

Successful Response

- ShareClaimResponse
  - `config_name` string, required
  - `label` string, required
  - `already_claimed` boolean, required

## 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)