# List the diagrams of one of your series

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

The account's diagrams published with this series id, by their place in the series.

`GET /user/diagrams/series/{seriesId}`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | List the diagrams of one of your series. |
| What does it take? | `seriesId` in the path. |
| What does it return? | Status 200 with a body of type [`HostedDiagramSeries`](https://docs.plotwork.dev/api/schemas.md#hosteddiagramseries). |
| What can go wrong? | `400` the series id is not letters, digits, - and _; `401` not signed in; `429` too many requests; `503` hosting is not set up on this server. Every failure uses the one error envelope. |

## What it does

The account's diagrams published with this series id, by their place in the series. An unknown series is an empty list.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `seriesId` | `string` | yes | The series id the parts were published with. |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The diagrams of the series. | [`HostedDiagramSeries`](https://docs.plotwork.dev/api/schemas.md#hosteddiagramseries) |
| 400 | The series id is not letters, digits, - and _. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 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) |
| 503 | Hosting is not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

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

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | `HostedDiagram[]` | yes | By place in the series, then newest first should two share a place. |
| `items[].id` | `string` | yes | The handle for managing the diagram (delete). It is not in the link. |
| `items[].url` | `string` | yes | The public address of the SVG. Anyone with the link can see it; the token in it cannot be guessed. |
| `items[].name` | `string \| null` | yes | The label given at publish, or null. |
| `items[].folder` | `string \| null` | yes | The folder it is filed in, such as `Payments/Checkout`, or null for the top level. |
| `items[].scheme` | `"light" \| "dark" \| "auto"` | yes | The color scheme it was drawn in: light, dark, or auto. |
| `items[].bytes` | `integer` | yes | Size of the stored SVG in bytes. |
| `items[].createdAt` | `integer` | yes | When it was first published, in milliseconds since the epoch. |
| `items[].publishedAt` | `integer` | yes | When it was last published, in milliseconds since the epoch. Publishing the same diagram again moves it. |
| `items[].expiresAt` | `integer \| null` | yes | When it will be deleted, in milliseconds since the epoch, or null when the plan keeps diagrams until you delete them. |
| `items[].locked` | `boolean` | yes | True while the diagram is locked: it cannot be deleted, renamed or moved until you unlock it. A lock does not stop it expiring on a plan that expires diagrams. |
| `items[].lockedAt` | `integer \| null` | yes | When it was locked, in milliseconds since the epoch, or null when it is not locked. |
| `items[].series` | `DiagramSeries` | yes | Its place in a series (the parts of one split import), or null when it is in none. |
| `items[].series.id` | `string` | yes | The series id the parts were published with. |
| `items[].series.index` | `integer` | yes | Its place in the series, from 1; 0 is the whole import combined into one diagram. |
| `items[].series.total` | `integer \| null` | yes | How many parts the publisher said the series has, or null. |

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