# List the diagrams of one series

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

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

`GET /orgs/{org}/diagrams/series/{seriesId}`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | List the diagrams of one series. |
| What does it take? | `org`, `seriesId` in the path. |
| What does it return? | Status 200 with a body of type [`OrganisationDiagramSeries`](https://docs.plotwork.dev/api/schemas.md#organisationdiagramseries). |
| What can go wrong? | `400` the series id is not letters, digits, - and _; `401` not signed in, or the key is not valid; `404` no such organisation, the caller is not a member of it, or the key belongs to another organisation; `429` too many requests, or the daily limit is used up; `503` organisations are not set up on this server. Every failure uses the one error envelope. |

## What it does

The organisation's diagrams published with this series id, by their place in the series. A diagram the caller may not see is left out; an unknown series is an empty list.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `org` | `string` | yes | The organisation's id or its slug. |
| `seriesId` | `string` | yes | The series id the parts were published with. |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The diagrams of the series. | [`OrganisationDiagramSeries`](https://docs.plotwork.dev/api/schemas.md#organisationdiagramseries) |
| 400 | The series id is not letters, digits, - and _. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 401 | Not signed in, or the key is not valid. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 404 | No such organisation, the caller is not a member of it, or the key belongs to another organisation. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests, or the daily limit is used up. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 503 | Organisations are not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

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

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | `OrganisationDiagram[]` | yes | By place in the series, then newest first should two share a place. |
| `items[].id` | `string` | yes | The handle for the diagram in the routes below. |
| `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[].createdBy` | `string \| null` | yes | The person it belongs to: the member who published it, or the person who connected the agent that did. Null when that account has left or an organisation key published it. |
| `items[].publishedVia` | `"person" \| "connection" \| "key" \| null` | yes | How it was published: `person` (signed in, or with a key the person made), `connection` (an agent connected to the organisation, whose person is `createdBy`), or `key` (an organisation key from Keys and CI). Null for a diagram published before this was recorded. |
| `items[].publishedKey` | `object \| null` | yes | The key behind a connection or an organisation key. Null for a person, and once the key no longer exists. |
| `items[].publishedKey.id` | `string` | yes | The key's id, as Keys and CI lists it. Never the key itself. |
| `items[].publishedKey.name` | `string \| null` | yes | The key's name, or null once the key is revoked. |
| `items[].publishedClient` | `string \| null` | yes | The client name the agent gave when it connected, such as `Claude Code`, for a connection only. at most 100 characters. |
| `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 owner's plan keeps diagrams until they are deleted. |
| `items[].viewUrl` | `string` | yes | A page in the portal that shows the diagram to a signed-in member. It is not a link anyone can open: an organisation's diagrams have no public address. |
| `items[].locked` | `boolean` | yes | True while the owner has the diagram locked: nobody can delete, rename or move it, its publisher and the owner included, until the owner unlocks it. A lock does not stop it expiring on a plan that expires diagrams. |
| `items[].lockedAt` | `integer \| null` | yes | When the owner locked it, in milliseconds since the epoch, or null when it is not locked. |
| `items[].restricted` | `true` | no | Present, and true, when the owner has restricted this diagram's folder and the caller is allowed in it, so the portal can show it as locked. Absent otherwise. A diagram in a folder the caller may not use is not listed at all. |
| `items[].keepInside` | `true` | no | Present, and true, when the folder rule over this diagram keeps its diagrams inside: the svg route refuses `?download=1` and the copy route refuses a copy (403 `orgs.folder_restricted`). Absent otherwise. |
| `items[].share` | `OrganisationDiagramShare` | yes | Its public link while the organisation shares it, or null. Only a diagram someone chose to share has one. |
| `items[].share.url` | `string` | yes | The public address, `{CDN_URL}/l/<token>.svg`. Anyone with it can see the picture, without its source. It keeps showing the latest version when the diagram is edited, and never changes. |
| `items[].share.sharedAt` | `integer` | yes | When the diagram was first shared, in milliseconds since the epoch. |
| `items[].kept` | `boolean` | yes | "Keep": true when an owner or admin keeps it from the library retention. The plan's own retention still applies. |
| `items[].deletesAt` | `integer \| null` | yes | When the retention deletes it, in milliseconds since the epoch: the nearer of the plan's expiry and "Delete library diagrams not updated for". Null when nothing will, and always null under a legal hold. |
| `items[].classification` | `Classification` | yes | A diagram's classification label: `public`, `internal` (the default, and what a diagram published before labels reads as) or `confidential`. Confidential is never shared publicly; under "Share only diagrams labelled Public" only public is. |
| `items[].pending` | `boolean` | yes | True while it is held for approval ("Publishing needs approval"): only its publisher and the approvers see it. |
| `items[].changePending` | `boolean` | yes | True while a new version of it waits for approval. The library shows this version until then. |
| `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 |