Embedding Utils

Get Document Embed

Retrieves limited metadata about the embedded document. If the embed is a snapshot-version embed, the metadata will be drawn from the state of the document at the time that the snapshot was created.

get/v1/documents/{documentId}/embeds/{embedId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/documents/{documentId}/embeds/{embedId}
  • Auth: OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: lucidchart.document.content.share.embed:readonly, lucidchart.document.app.picker.share.embed:readonly, lucidscale.document.content.share.embed:readonly, lucidscale.document.app.picker.share.embed:readonly, lucidspark.document.content.share.embed:readonly, lucidspark.document.app.picker.share.embed:readonly)

Path parameters

documentIdstring uuid required

ID of the embedded document to retrieve.

embedIdstring uuid required

ID of the document embed to retrieve.

Response

OK. Returns a Document Embed Resource containing information about the requested document embed.

embedIdstring uuid

Unique identifier of the embed.

documentIdstring uuid

Unique identifier of the document.

embedVersionstring

The version of the embed.

createdstring date

When the embed was created.

modifiedstring date

When the embed was last modified.

Example response

{
  "embedId": "ec890631-c150-461c-992f-b96533aa05f4",
  "documentId": "001bd56d-1b10-4196-8ac6-45e3c22bd1c6",
  "embedVersion": "snapshot-version",
  "created": "2021-10-01T20:49:36.169Z",
  "modified": "2021-10-01T20:49:36.169Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.