Diagrams

Find diagrams

Changed on

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.

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

Query parameters

querystring

Text to look for in the title, key or brief, ignoring case

keystring

A key you gave a diagram: the list holds that one diagram, or nothing. The other parameters are ignored.

limitinteger

Diagrams per page, 1 to 50; a value outside that range is clamped

cursorstring

nextCursor from the previous page

deletedboolean

true lists the diagrams that can still be restored

Response

A page of diagrams

nextCursorstring

Changes