---
title: "Get Share Status"
method: GET
path: "/api/shares/by-config/{config_name}"
tags: ["shares"]
---

# Get Share Status

`GET /api/shares/by-config/{config_name}`

## 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/by-config/{config_name}`
- Auth: HTTP bearer

## Path parameters

- `config_name` string, required

## Response `200`

Successful Response

- ShareStatusResponse
  - `shared` boolean, required
  - `token` string
  - `share_url` string
  - `success_pct` integer

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