Figma
Design file access and workflow automation API
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.figma.com/ | link | — | — | — |
Actions (50)
SCIM API · 12
- Create SCIM groupPOST /Groups
Create a SCIM group.
documented - Create SCIM userPOST /Users
Provision a new SCIM user.
documented - Delete SCIM groupDELETE /Groups/{figmaGroupId}
Delete a SCIM group by its ID.
documented - Delete SCIM userDELETE /Users/{figmaUserId}
Delete a SCIM user by its Figma user ID.
documented - List SCIM groupsGET /Groups
List SCIM groups.
documented - List SCIM usersGET /Users
List SCIM provisioned users.
documented - Patch SCIM groupPATCH /Groups/{figmaGroupId}
Patch a SCIM group by its ID.
documented - Patch SCIM userPATCH /Users/{figmaUserId}
Patch a SCIM user by its Figma user ID.
documented - Read SCIM groupGET /Groups/{figmaGroupId}
Read a SCIM group by its ID.
documented - Read service provider configGET /ServiceProviderConfig
Get SCIM configuration for the service provider.
documented - Update SCIM groupPUT /Groups/{figmaGroupId}
Update a SCIM group by its ID.
documented - Update SCIM userPUT /Users/{figmaUserId}
Update a SCIM user by its Figma user ID.
documented
Webhooks · 7
- Create webhookPOST /v2/webhooks
Create a new webhook for a given context (team/project/file).
documented - Delete webhookDELETE /v2/webhooks/{webhook_id}
Delete a webhook by ID.
documented - List team webhooks (deprecated)GET /v2/teams/{team_id}/webhooks
Deprecated endpoint; use GET /v2/webhooks with context=team and context_id=team_id instead.
documented - List webhook requestsGET /v2/webhooks/{webhook_id}/requests
Return webhook requests for a given webhook.
documented - List webhooksGET /v2/webhooks
Return webhooks for a given context or plan (paginated).
documented - Read webhookGET /v2/webhooks/{webhook_id}
Retrieve a specific webhook by ID.
documented - Update webhookPUT /v2/webhooks/{webhook_id}
Update properties of an existing webhook.
documented
Library Analytics · 6
- Library component actionsGET /v1/analytics/libraries/{library_file_key}/component/actions
Time-series of component insertions/detachments for a library.
documented - Library component usagesGET /v1/analytics/libraries/{library_file_key}/component/usages
Usage data of components across files/teams for a library.
documented - Library style actionsGET /v1/analytics/libraries/{library_file_key}/style/actions
Time-series of style insertions/detachments for a library.
documented - Library style usagesGET /v1/analytics/libraries/{library_file_key}/style/usages
Usage data of styles across files/teams for a library.
documented - Library variable actionsGET /v1/analytics/libraries/{library_file_key}/variable/actions
Time-series of variable actions for a library.
documented - Library variable usagesGET /v1/analytics/libraries/{library_file_key}/variable/usages
Usage data of variables across files/teams for a library.
documented
Files · 5
- Read fileGET /v1/files/{key}
Return the JSON representation of a file, including document tree, components, styles, branches, etc.
documented - Read file imagesGET /v1/files/{key}/images
Render and return image URLs for nodes in a file (single or multiple ids).
documented - Read file metadataGET /v1/files/{key}/meta
Return metadata about the file (name, last modified, editor type, thumbnail, etc.).
documented - Read file nodesGET /v1/files/{key}/nodes
Return the nodes specified by the ids parameter from the given file.
documented - Read image fillsGET /v1/files/{key}/images
Return image URLs for image fills contained in the file (image refs from Paint fills).
documented
Component Sets · 3
- List file component setsGET /v1/files/{file_key}/component_sets
List published component sets in a file library.
documented - List team component setsGET /v1/teams/{team_id}/component_sets
List published component sets in a team library.
documented - Read component setGET /v1/component_sets/{key}
Read metadata for a published component set by key.
documented
Components · 3
- List file componentsGET /v1/files/{file_key}/components
Return a list of published components in a file library.
documented - List team componentsGET /v1/teams/{team_id}/components
Return a paginated list of published components in a team library.
documented - Read component metadataGET /v1/components/{key}
Get metadata for a published component by key.
documented
Styles · 3
Variables · 3
- Bulk edit variablesPOST /v1/files/{file_key}/variables
Bulk create, update, and delete local variables and variable collections in a file.
documented - Read local variablesGET /v1/files/{file_key}/variables/local
List local variables and remote variables used in the specified file.
documented - Read published variablesGET /v1/files/{file_key}/variables/published
List variables that have been published from the specified file.
documented