Skip to main content

Entity types

Below are the common types you can find under the entity field in the API response:

note

Projects are now known as folders.

NameProperties

file​

A Figma Design or FigJam file.

keyString
Unique identifier of the file.
nameString
Name of the file.
editor_typeString
Indicates if the object is a file on Figma Design or FigJam. Can be figma or figjam.
link_accessString
Access policy for users who have the link to the file. Can be view, edit, org_view, org_edit or inherit.
proto_link_accessString
Access policy for users who have the link to the file's prototype. Can be view, org_view or inherit.

file_repo​

A file branch that diverges from and can be merged back into the main file.

idString
Unique identifier of the file branch.
nameString
Name of the file.
main_file_keyString
Key of the main file.

idp_user​

SCIM metadata of a user if managed by an identity provider.

idString
Unique stable id of the user.
user_nameString
Email address of the user.
org_saml_idString
The SAML id of the org the user belongs to.
external_idString
The identity provider's external id for the user.

policy_acknowledgement_config​

An Enterprise internal policy acknowledgement config.

idString
Unique identifier of the policy.
titleString
Title of the policy.
audienceString
Audience of the policy.
cadenceString
Cadence of the policy.
enabled_atString
Date and time the policy was enabled.
enabled_statusString
Enabled status of the policy.

org​

A Figma organization.

idString
Unique identifier of the org.
nameString
Name of the org.

plugin​

A Figma plugin.

idString
Unique identifier of the plugin.
nameString
Name of the plugin.
editor_typeString
Indicates if the object is a plugin is available on Figma Design or FigJam. Can be figma or figjam.

project​

A folder that a collection of Figma files are grouped under.

idString
Unique identifier of the folder.
nameString
Name of the folder.

team​

A Figma team that contains multiple users and folders.

idString
Unique identifier of the team.
nameString
Name of the team.

user​

A Figma user.

idString
Unique stable id of the user.
nameString
Name of the user.
emailString
Email associated with the user's account.

widget​

A Figma widget.

idString
Unique identifier of the widget.
nameString
Name of the widget.
editor_typeString
Indicates if the widget is available on Figma Design or FigJam. Can be figma or figjam.

workspace​

Part of the organizational hierarchy of managing files and users within Figma, only available on the Enterprise Plan.

idString
Unique identifier of the workspace.
nameString
Name of the workspace.