List Mermaid Diagrams

Returns a paginated list of Mermaid diagrams in a Lucidchart or Lucidspark document.

Valid Authentication Methods

API Key Grants:

  • DocumentReadonly

OAuth 2.0 User Token Scopes:

  • lucidchart.document.content:readonly
  • lucidspark.document.content:readonly
  • lucid.document.content:readonly
Path Params
uuid
required

ID of the document containing the Mermaid diagrams.

Query Params
integer
≥ 0
Defaults to 200

Number of Mermaid diagrams to return. Values of 0 or greater than 200 return up to 200 diagrams.

string

Token from the previous response's Link header used to retrieve the next page.

Responses

400

Bad Request if the document ID, page size, or page token is invalid, or if the document is not a Lucidchart or Lucidspark document.

403

Forbidden if the app making the request does not have permission to the document, or if the document does not exist.

404

Not Found if Mermaid diagram data cannot be found for the document.

429

Too Many Requests if the request exceeds the rate limit.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json