Docs
Schedule demo Open app

List diagrams in a file

GET https://app.eraser.io/api/files/{fileId}/diagrams

Example request

curl --location 'https://app.eraser.io/api/files/abc123/diagrams' \
--header 'Authorization: Bearer $YOUR-TOKEN-HERE'

Example response

[
  {
    "id": "diag1",
    "diagramUrl": "https://app.eraser.io/workspace/abc123?diagram=diag1&layout=canvas",
    "diagramType": "sequence-diagram",
    "code": "A > B: Hello",
    "updatedAt": "2025-07-15T09:30:00.000Z"
  }
]

Path parameters

fileId string requiredpath

ID of the file containing the diagrams

Responses

200 – Array of diagrams in the file

id string required

Unique identifier for the diagram

diagramUrl string required

URL to view the diagram in the Eraser canvas

diagramType string required

Type of the diagram

  • sequence-diagram
  • entity-relationship-diagram
  • cloud-architecture-diagram
  • flowchart-diagram
  • bpmn-diagram
code string required

Eraser DSL code for the diagram

updatedAt string required

ISO 8601 timestamp of when the diagram was last updated

200 response
[
  {
    "id": "string",
    "diagramUrl": "https://app.eraser.io/workspace/abc123?diagram=def456&layout=canvas",
    "diagramType": "sequence-diagram",
    "code": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

400 – Invalid file ID

401 – Missing or invalid bearer token

403 – Unauthorized

404 – File not found (or file is private, archived, a template, or belongs to a different team)

500 – Internal server error