---
title: "Get oEmbed data"
method: GET
path: "/v1/oembed"
tags: ["oEmbed"]
---

# Get oEmbed data

`GET /v1/oembed`

Returns oEmbed data for a Figma file or published Make site URL, following the [oEmbed specification](https://oembed.com/).

## Query parameters

- `url` string, required
- `maxwidth` integer
- `maxheight` integer

## Response `200`

Response from the GET /v1/oembed endpoint.

- object
  - `version` string, required — The oEmbed specification version. Always "1.0".
  - `type` string, required — The oEmbed response type. Always "rich".
  - `title` string, required — The title of the Figma file or published Make site.
  - `key` string — The key of the Figma file. Not present for published Makes
  - `url` string, required — The canonical URL of the resource.
  - `provider_name` string, required — The name of the content provider. Always "Figma" or "Make".
  - `provider_url` string, required — The URL of the content provider's website. Always "https://www.figma.com".
  - `cache_age` integer, required — Suggested cache lifetime for this response in seconds. Always 3600.
  - `width` integer, required — Width of the embed in pixels.
  - `height` integer, required — Height of the embed in pixels.
  - `html` string, required — The HTML for embedding the file. Contains an iframe pointing to the Figma embed URL.
  - `is_published_site` boolean — Only present and "true" when the resource is a published Make.
  - `folder_name` string — The name of the folder containing the file, if the file resides in a folder.
  - `thumbnail_url` string — URL of a thumbnail image for the file.
  - `thumbnail_width` integer — Width of the thumbnail image in pixels.
  - `thumbnail_height` integer — Height of the thumbnail image in pixels.

## Other responses

- `400` — Bad request. Parameters are invalid or malformed. Please check the input formats. This error can also happen if the requested resources are too large to complete the request, which results in a timeout. Please reduce the number and size of objects requested.
- `404` — The requested file or resource was not found.
- `429` — In some cases API requests may be throttled or rate limited. Please wait a while before attempting the request again (typically a minute).
- `501` — The server does not support the functionality required to fulfill the request.

---

[API](https://skmtc.dev/figma/apis/figma-api.md) · [All operations](https://skmtc.dev/figma/apis/figma-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/figma/figma-api/revisions/d7ab5681d84c/schema)