# Read the legend of your diagrams

> Page: https://docs.plotwork.dev/api/get-user-legend. Index of every page: https://docs.plotwork.dev/llms.txt

on (the default) or off, for the flow diagrams you draw on the hosted service when no organisation decides it.

`GET /user/legend`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Read the legend of your diagrams. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type [`UserLegend`](https://docs.plotwork.dev/api/schemas.md#userlegend). |
| What can go wrong? | `401` not signed in; `429` too many requests. Every failure uses the one error envelope. |

## What it does

on (the default) or off, for the flow diagrams you draw on the hosted service when no organisation decides it.

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The choice. | [`UserLegend`](https://docs.plotwork.dev/api/schemas.md#userlegend) |
| 401 | Not signed in. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

A 200 answer has the type [`UserLegend`](https://docs.plotwork.dev/api/schemas.md#userlegend).

| Field | Type | Required | Description |
|---|---|---|---|
| `legend` | `"on" \| "off"` | yes | The legend of flow diagrams you draw on the hosted service, on (the default) or off, when no organisation decides it. A repository's plotwork.config.json and a diagram's header still win. |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |