---
title: "Get component"
method: GET
path: "/v1/components/{key}"
tags: ["Components"]
---

# Get component

`GET /v1/components/{key}`

Get metadata on a component by key.

## Path parameters

- `key` string, required

## Response `200`

Response from the GET /v1/components/{key} endpoint.

- object
  - `status` 200, required — The status of the request.
  - `error` false, required — For successful requests, this value is always `false`.
  - `meta` PublishedComponent, required — An arrangement of published UI elements that can be instantiated across figma files.
    - `key` string, required — The unique identifier for the component.
    - `file_key` string, required — The unique identifier of the Figma file that contains the component.
    - `node_id` string, required — The unique identifier of the component node within the Figma file.
    - `thumbnail_url` string — A URL to a thumbnail image of the component.
    - `name` string, required — The name of the component.
    - `description` string, required — The description of the component as entered by the publisher.
    - `created_at` string, date-time, required — The UTC ISO 8601 time when the component was created.
    - `updated_at` string, date-time, required — The UTC ISO 8601 time when the component was last updated.
    - `user` User, required — A description of a user.
      - `id` string, required — Unique stable id of the user.
      - `handle` string, required — Name of the user.
      - `img_url` string, required — URL link to the user's profile image.
    - `containing_frame` FrameInfo — Data on the frame a component resides in.
      - `nodeId` string — The ID of the frame node within the file.
      - `name` string — The name of the frame node.
      - `backgroundColor` string — The background color of the frame node.
      - `pageId` string, required — The ID of the page containing the frame node.
      - `pageName` string, required — The name of the page containing the frame node.
      - `containingStateGroup` object, nullable — Deprecated - Use containingComponentSet instead.
        - `nodeId` string — The ID of the state group node.
        - `name` string — The name of the state group node.
      - `containingComponentSet` object, nullable — The component set node that contains the frame node.
        - `nodeId` string — The ID of the component set node.
        - `name` string — The name of the component set node.

## 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.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.
- `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).
- `500` — An internal server error occurred.

## Changes

> 36 revisions in range; 33 could not be searched.

- **2023-12-14** `de5c0106668d` — 2 warning, 2 info
  - removed the optional property `meta/containing_frame/containingComponentSet` from the response with the `200` status
  - removed the optional property `meta/containing_frame/containingStateGroup` from the response with the `200` status
  - the endpoint scheme security `PlanAccessToken` was removed from the API
  - the security scope `library_assets:read` was removed from the endpoint's security scheme `OAuth2`

[Change history](https://skmtc.dev/figma/apis/figma-api/changes/v1/components/:key/get.md)

---

[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)