---
title: "Find diagrams"
method: GET
path: "/v1/diagrams"
tags: ["Diagrams"]
---

# Find diagrams

`GET /v1/diagrams`

## Request

- Base URL: `https://api.zindex.ai`
- URL: `https://api.zindex.ai/v1/diagrams`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

The workspace's live diagrams, most recently changed first. query matches the title, key or brief, ignoring case; key returns the one diagram with that key. deleted=true lists instead the diagrams deleted in the last 24 hours, which POST /v1/diagrams/{id}/undelete can still restore, most recently deleted first, each with deletedAt and expiresAt (when the undo window closes); it isn't paged.

## Query parameters

- `query` string
- `key` string
- `limit` integer
- `cursor` string
- `deleted` boolean

## Response `200`

A page of diagrams

- object
  - `diagrams` object[]
    - `id` string
    - `key` string: Absent when the diagram has none
    - `title` string, nullable
    - `revision` integer
    - `updatedAt` string, date-time
    - `deletedAt` string, date-time: With deleted=true
    - `expiresAt` string, date-time: With deleted=true: when it can no longer be restored
  - `nextCursor` string

## Other responses

- `400`: deleted is not true or false
- `401`: Missing or invalid API key. Response includes a `code` field that distinguishes the failure mode so clients (dashboard, MCP server) can render actionable copy: `AUTH_REQUIRED` (no key or session was sent), `API_KEY_INVALID` (key not found), `API_KEY_REVOKED` (key was revoked, or its person is no longer in its workspace), `API_KEY_EXPIRED` (key passed its expires_at), and for the site's session cookie `SESSION_EXPIRED` (past its 24 hours), `SESSION_REVOKED` (the account's sessions were ended, for example by a password reset) and `SESSION_INVALID` (not a session this server signed).
- `429`: RATE_LIMITED: over the request rate limit (see Rate Limiting). Wait retryAfter seconds (also the Retry-After header), then try again.

## Changes

- **2026-10-20** `1d21bd5bbf8e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zindex/apis/zindex-api/changes/v1/diagrams/get.md)

---

[API](https://skmtc.dev/zindex/apis/zindex-api.md) · [All operations](https://skmtc.dev/zindex/apis/zindex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zindex/apis/zindex-api/revisions/1d21bd5bbf8e?raw)