Figma REST API - Parable

Figma is a collaborative design platform for building user interfaces, prototyping, and design systems. The Figma REST API provides access to files, projects, components, styles, comments, version history, webhooks, and team/organization management. Base URL: https://api.figma.com with v1 and v2 versioned endpoints.

Overview
Setup Guide
Permissions
Troubleshooting

Connect Parable to Figma using either a Personal Access Token (PAT) or a Plan Access Token. Enter whichever you have in the same token field. Parable ingests design assets, version history, team structure, and (Enterprise, opt-in) activity logs.

Info: Which token should I use? A Plan Access Token is preferred for Organization/Enterprise plans: it is not tied to an individual user, supports up to a 1-year expiration, and can be scoped with a resource allowlist. A Personal Access Token is tied to the minting user and expires within 90 days. If you use a Plan Access Token, make sure its resource allowlist includes every team you configure in Parable.

Design assets

Projects, files, components, variables, and version history

Activity & admin

File comments and org-level activity logs (Enterprise, opt-in)

Data streams

This Provider Plugin defines 12 data streams.

Stream	Description	Sync
`team_projects`	Lists all projects within a Figma team. Requires a team_id parent context. Returns project id and name.	full
`project_files`	Lists all files within a Figma project. Requires a project_id parent context. Returns file key, name, thumbnail URL, and last modified timestamp.	full
`file_versions`	Returns paginated version history for a Figma file. Requires a file_key parent context. Pagination uses next_page URL from the pagination object in the response.	full
`file_comments`	Returns all comments on a Figma file. Requires a file_key parent context.	full
`team_components`	Lists all published components for a Figma team. Cursor-based pagination using after parameter. Requires team_id parent context.	full
`team_component_sets`	Lists all published component sets for a Figma team. Cursor-based pagination using after parameter. Requires team_id parent context.	full
`team_styles`	Lists all published styles for a Figma team. Cursor-based pagination using after parameter. Requires team_id parent context.	full
`file_components`	Lists all components within a specific Figma file. Requires a file_key parent context.	full
`file_styles`	Lists all styles within a specific Figma file. Requires a file_key parent context.	full
`comment_reactions`	Returns reactions on a specific comment in a Figma file. Requires file_key and comment_id parent context. Cursor-based pagination.	full
`file_dev_resources`	Returns dev resources attached to a Figma file. Requires a file_key parent context.	full
`activity_logs`	Retrieve organization activity log events from Figma. Returns timestamped events covering user and admin activity: file opens, edits, creation/deletion, comments, sharing changes, team membership changes, plugin usage, and administrative actions. Enterprise plan required. Organization admin must authorize.	incremental

Figma

What You’ll Need

Credential	What it is
Personal Access Token	Long-lived token minted from a user’s Figma account settings
Plan Access Token	Org/Enterprise token created by a plan admin, not tied to a user (recommended for org-wide automation)

Info: Service account required. PATs are tied to the minting user — if that user is removed from the team the token is revoked immediately and ingestion stops. Always mint from a dedicated service-account user on a paid plan (Professional, Organization, or Enterprise).

activity_logs is disabled by default. Enable it only if your organization is on the Enterprise plan with the service-account user having org admin access. Non-Enterprise tenants will receive 402 payment_required on every sync.

Info: Using a Plan Access Token instead? Org/Enterprise admins can create one at figma.com/developers/tokens (requires 2FA). Choose the same scopes listed in Step 2, and on the Choose resources page either allow all resources or add every team you will sync in Parable. Then skip to Step 3 and paste it into the token field.

Step 1: Open Figma Security settings

Sign in to Figma as the dedicated service-account user.
Click your avatar in the top-right and open Settings.
Switch to the Security tab.
Scroll to Personal access tokens.

Step 2: Generate the token

Click Generate new token.
Set:
- Token name — something traceable, e.g. parable-platform-prod.
- Expiration — choose the longest duration your security policy allows (30 days, 60 days, 90 days, 180 days, or No expiration). Rotate at least every 12 months even if using no expiration.
- Scopes — add the following:

Scope	Purpose
`projects:read`	Team projects and project file listings
`file_versions:read`	File version history
`file_dev_resources:read`	Dev resources
`file_comments:read`	File comments and reactions
`team_library_content:read`	Team library components, component sets, and styles
`library_content:read`	File-level library components and styles
`org:activity_log_read`	Org activity logs (Enterprise only)

Copy the token.

Warning: Copy your Personal Access Token now! This is the only time it will be displayed. Store it in a secure password manager before closing this page.

Step 3: Enter values in the form

Personal Access Token: Paste the token from Figma.
Team IDs (optional): Add one row per Figma team you want to sync. Find each team ID in the Figma URL: figma.com/files/team/{team_id}/.... Leave empty to skip team-scoped taps that require team_id.
Click Save & test connection.

Use an environment variable so the secret never enters shell history:Probe a team you intend to sync (works for both token types). /v1/me does not work with a Plan Access Token, so do not use it to verify.

Test Authentication

read -rs -p "Figma token: " FIGMA_TOKEN && echo
read -r -p "Figma team id: " FIGMA_TEAM_ID
curl --silent -H "X-Figma-Token: ${FIGMA_TOKEN}" "https://api.figma.com/v1/teams/${FIGMA_TEAM_ID}/projects"
unset FIGMA_TOKEN

Success: Success! If you received a 200 OK response with valid data, your credentials are configured correctly. You can now configure this Provider in Parable.

Tip: A 200 OK response with a projects array means the token can read that team. A 403 means the token is invalid/revoked, is missing the projects:read scope, or — for a Plan Access Token — the team is outside its resource allowlist. A 404 means the team id is wrong or the token’s user has no access to it.

Tip: Rate Limits: Figma enforces rate limits of 60 requests/minute per token on /v1/files; 10 requests/second overall. Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.

Activity Logs

Developer identifier: activity_logsActivity Logs contain organization activity log events from Figma. Returns timestamped events covering user and admin activity: file opens, edits, creation/deletion, comments, sharing changes, team membership changes, plugin usage, and administrative actions. Enterprise plan required. Organization admin must authorize.

Enables: trace organization events such as file changes, sharing changes, and membership administration to recorded actors and times.
Scope: Reads provider changes through GET /{apiVersion}/activity_logs using the declared incremental request boundary. This Enterprise-only operation requires organization-administrator authorization; events outside the returned organization log are absent.

Action

Developer identifier: activity_logs.actionAction captures the action taken, including its type and event-specific details. It preserves the provider’s current classification of this record.

Enables: separate activity log records by the exact provider-reported action value when describing their recorded state.
Interpretation: The provider supplies action per activity log event record using its own state vocabulary; unknown and missing values must remain distinct.

Details

Developer identifier: activity_logs.action.detailsDetails records action-specific details that vary by action type. It retains configured attributes whose keys or shape are not fixed by this base schema.

Enables: interpret details according to the provider and Workspace configuration that produced each activity log record.
Interpretation: Keys and value shapes within details can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.

Type

Developer identifier: activity_logs.action.typeType states action type (e.g., file_view, file_edit, comment_add, team_member_add, admin_settings_change). It preserves the provider’s current classification of this record.

Enables: separate activity log records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per activity action record using its own state vocabulary; unknown and missing values must remain distinct.

Actor

Developer identifier: activity_logs.actorActor captures the user who performed the action. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the activity log event record to the provider-reported actor represented by actor.
Interpretation: The provider supplies actor as identity or attribution context on each activity log event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: activity_logs.actor.emailEmail records email address of the actor. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the activity actor record to the provider-reported person or account represented by email.
Interpretation: The provider supplies email as identity or attribution context on each activity actor record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: activity_logs.actor.idID is the unique identifier of the actor. It is needed to resolve references that repeat the same provider identifier.

Enables: match activity log records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on ActivityActor. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: activity_logs.actor.nameName records display name of the actor. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the activity actor record to the provider-reported person or account represented by name.
Interpretation: The provider supplies name as identity or attribution context on each activity actor record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Type

Developer identifier: activity_logs.actor.typeType states type of the actor (e.g., user, service_account). It preserves the provider’s current classification of this record.

Enables: separate activity log records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per activity actor record using its own state vocabulary; unknown and missing values must remain distinct.

Context

Developer identifier: activity_logs.contextContext records client and network context in which the action occurred. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested context object into its declared child fields for each activity log event record.
Interpretation: The provider returns context as a nested object or reference on ActivityLogEvent; an absent value does not prove that no related object exists outside the credential’s visibility.

Client Name

Developer identifier: activity_logs.context.client_nameClient Name records name of the client from which the action was performed (e.g., figma_web, figma_desktop). It preserves the client environment reported with the event.

Enables: count Mixpanel events by the reported client name client environment.
Interpretation: Mixpanel supplies client_name per tracked event from client metadata; missing values do not identify an operating system or browser.

IP Address

Developer identifier: activity_logs.context.ip_addressIP Address records IP address from which the action was performed. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: segment activity log records by the recorded IP address without inferring a person’s physical presence.
Interpretation: The provider supplies ip_address as location or localization context per activity context record; it does not establish a person’s real-time physical location.

Is Figma Support Team Action

Developer identifier: activity_logs.context.is_figma_support_team_actionIs Figma Support Team Action indicates whether the action was performed by the Figma support team. It preserves the provider-reported yes-or-no condition for this record.

Enables: select activity log records for which the provider reports is figma support team action as true or false.
Interpretation: The provider supplies is_figma_support_team_action as a boolean per activity context record; false and missing are distinct when the field is optional.

Entity

Developer identifier: activity_logs.entityEntity captures the primary entity (file, project, team, etc.) that was acted upon. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: associate each activity log event record with the specific provider container named by entity.
Interpretation: The provider returns entity as a nested object or reference on ActivityLogEvent; an absent value does not prove that no related object exists outside the credential’s visibility.

Key

Developer identifier: activity_logs.entity.keyKey is the unique key of the entity. It is needed to resolve references that repeat the same provider identifier.

Enables: match activity log records to provider records that carry the same key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies key as a record-level identifier on ActivityEntity. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: activity_logs.entity.nameName records display name of the entity. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma activity log record.
Interpretation: The value covers only the activity logs content returned by this Figma operation; unrequested canvas content is not inferred.

Type

Developer identifier: activity_logs.entity.typeType states type of the entity (e.g., file, project, team, org). It preserves the provider’s current classification of this record.

Enables: separate activity log records by the exact provider-reported type value when describing their recorded state.
Interpretation: The provider supplies type per activity entity record using its own state vocabulary; unknown and missing values must remain distinct.

Developer identifier: activity_logs.idID is the unique identifier for the activity log event. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same activity log event source row before constructing its represented state.
Interpretation: The provider supplies id at one value per activity log event record, and x-transformDedupKey explicitly marks it as the record key.

Timestamp

Developer identifier: activity_logs.timestampTimestamp records unix epoch seconds when the event occurred. It anchors the named event or boundary on the record’s timeline.

Enables: place activity log records on a timeline by timestamp and select the records within an explicit reporting window.
Interpretation: The provider supplies timestamp per activity log event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Comment Reactions

Developer identifier: comment_reactionsComment Reactions contain reactions on a specific comment in a Figma file. Requires file_key and comment_id parent context. Cursor-based pagination.

Enables: count and attribute the reactions recorded on a specific file comment.
Scope: Reads the declared collection through GET /{apiVersion}/files/{file_key}/comments/{id}/reactions as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Comment ID

Developer identifier: comment_reactions.comment_idComment ID identifies parent id injected by the ingestor from the file_comments to comment_reactions traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match comment reaction records to provider records that carry the same comment ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies comment_id as a record-level identifier on CommentReaction. It is not a uniqueness guarantee unless a connector directive says so.

Created At

Developer identifier: comment_reactions.created_atCreated At records ISO 8601 timestamp indicating when the reaction was created. It anchors the named event or boundary on the record’s timeline.

Enables: place comment reaction records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per comment reaction record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Emoji

Developer identifier: comment_reactions.emojiEmoji captures the emoji shortcode representing the reaction. It preserves the provider’s visual treatment for the represented object.

Enables: reproduce or compare the provider-supplied emoji for the represented design or board object.
Interpretation: The provider supplies emoji in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.

File Key

Developer identifier: comment_reactions.file_keyFile Key identifies parent file_key injected by the ingestor from the file_comments to comment_reactions traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match comment reaction records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on CommentReaction. It is not a uniqueness guarantee unless a connector directive says so.

Developer identifier: comment_reactions.idID identifies synthetic sha1(file_key|comment_id|emoji); emoji alone collides across comments. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same comment reaction source row before constructing its represented state.
Interpretation: Parable generates id at one value per comment reaction record, and x-transformDedupKey explicitly marks it as the record key.

User

Developer identifier: comment_reactions.userUser captures the user who posted this reaction on the comment. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the comment reaction record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each comment reaction record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: comment_reactions.user.handleHandle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the reaction user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each reaction user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: comment_reactions.user.idID is the unique identifier for the Figma user. It is needed to resolve references that repeat the same provider identifier.

Enables: match comment reaction records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on ReactionUser. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: comment_reactions.user.img_urlImg URL records URL to the user’s profile image/avatar. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a reaction user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each reaction user record. Availability still follows the provider’s permissions and retention.

File Comments

Developer identifier: file_commentsFile Comments contain all comments on a Figma file. Requires a file_key parent context.

Enables: review comment text and authorship attached to each design file.
Scope: Reads the declared collection through GET /{apiVersion}/files/{key}/comments as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Client Meta

Developer identifier: file_comments.client_metaClient Meta records positional metadata indicating where the comment was placed on the canvas or within a frame. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: place the represented design or board object using its provider canvas client meta.
Interpretation: The provider supplies client_meta in its canvas coordinate system for this object; it is not a geographic coordinate.

Node ID

Developer identifier: file_comments.client_meta.node_idNode ID captures the node ID the comment is pinned to, if applicable. It is needed to resolve references that repeat the same provider identifier.

Enables: match file comment records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on ClientMeta. It is not a uniqueness guarantee unless a connector directive says so.

Node Offset

Developer identifier: file_comments.client_meta.node_offsetNode Offset records offset from the node origin where the comment is pinned. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: place the represented design or board object using its provider canvas node offset.
Interpretation: The provider supplies node_offset in its canvas coordinate system for this object; it is not a geographic coordinate.

X Coordinate

Developer identifier: file_comments.client_meta.node_offset.xX Coordinate records x component. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: place the represented design or board object using its provider canvas x coordinate.
Interpretation: The provider supplies x in its canvas coordinate system for this object; it is not a geographic coordinate.

Y Coordinate

Developer identifier: file_comments.client_meta.node_offset.yY Coordinate records y component. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: place the represented design or board object using its provider canvas y coordinate.
Interpretation: The provider supplies y in its canvas coordinate system for this object; it is not a geographic coordinate.

X Coordinate

Developer identifier: file_comments.client_meta.xX Coordinate records x coordinate of the comment pin. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: place the represented design or board object using its provider canvas x coordinate.
Interpretation: The provider supplies x in its canvas coordinate system for this object; it is not a geographic coordinate.

Y Coordinate

Developer identifier: file_comments.client_meta.yY Coordinate records y coordinate of the comment pin. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.

Enables: place the represented design or board object using its provider canvas y coordinate.
Interpretation: The provider supplies y in its canvas coordinate system for this object; it is not a geographic coordinate.

Created At

Developer identifier: file_comments.created_atCreated At records ISO 8601 timestamp when the comment was created. It anchors the named event or boundary on the record’s timeline.

Enables: place file comment records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per file comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

File Key

Developer identifier: file_comments.file_keyFile Key captures the key of the Figma file this comment belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match file comment records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on FileComment. It is not a uniqueness guarantee unless a connector directive says so.

Developer identifier: file_comments.idID is the unique identifier for the comment. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same file comment source row before constructing its represented state.
Interpretation: The provider supplies id at one value per file comment record, and x-transformDedupKey explicitly marks it as the record key.

Message

Developer identifier: file_comments.messageMessage captures the comment message text. Returned as markdown when as_md=true. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact message returned for each Figma file comment record.
Interpretation: The value covers only the file comments content returned by this Figma operation; unrequested canvas content is not inferred.

Order ID

Developer identifier: file_comments.order_idOrder ID contains an ordering identifier used to sort comments chronologically. It is needed to resolve references that repeat the same provider identifier.

Enables: match file comment records to provider records that carry the same order ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies order_id as a record-level identifier on FileComment. It is not a uniqueness guarantee unless a connector directive says so.

Parent ID

Developer identifier: file_comments.parent_idParent ID captures the ID of the parent comment if this comment is a reply. Empty string if top-level. It is needed to resolve references that repeat the same provider identifier.

Enables: match file comment records to provider records that carry the same parent ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies parent_id as a record-level identifier on FileComment. It is not a uniqueness guarantee unless a connector directive says so.

Resolved At

Developer identifier: file_comments.resolved_atResolved At records ISO 8601 timestamp when the comment was resolved. Null if unresolved. It anchors the named event or boundary on the record’s timeline.

Enables: place file comment records on a timeline by resolved at and select the records within an explicit reporting window.
Interpretation: The provider supplies resolved_at per file comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

User

Developer identifier: file_comments.userUser captures the user who posted the comment. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the file comment record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each file comment record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: file_comments.user.handleHandle records display name / handle of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the comment user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each comment user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: file_comments.user.idID is the unique user identifier. It is needed to resolve references that repeat the same provider identifier.

Enables: match file comment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on CommentUser. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: file_comments.user.img_urlImg URL records URL of the user’s profile image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a comment user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each comment user record. Availability still follows the provider’s permissions and retention.

File Components

Developer identifier: file_componentsFile Components contain all components within a specific Figma file. Requires a file_key parent context.

Enables: inspect component definitions local to a specific design file.
Scope: Reads the declared collection through GET /{apiVersion}/files/{key}/components as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Component Set ID

Developer identifier: file_components.component_set_idComponent Set ID identifies if this component is part of a component set (variants), this is the key of the parent component set. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same component set ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies component_set_id as a record-level identifier on FileComponent. It is not a uniqueness guarantee unless a connector directive says so.

Component Set Name

Developer identifier: file_components.component_set_nameComponent Set Name captures the name of the parent component set, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact component set name returned for each Figma file component record.
Interpretation: The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.

Containing Frame

Developer identifier: file_components.containing_frameContaining Frame records information about the frame that contains this component in the file. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested containing frame object into its declared child fields for each file component record.
Interpretation: The provider returns containing_frame as a nested object or reference on FileComponent; an absent value does not prove that no related object exists outside the credential’s visibility.

Background Color

Developer identifier: file_components.containing_frame.backgroundColorBackground Color records background color of the containing frame. It preserves the provider’s visual treatment for the represented object.

Enables: reproduce or compare the provider-supplied background color for the represented design or board object.
Interpretation: The provider supplies backgroundColor in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.

Containing State Group

Developer identifier: file_components.containing_frame.containingStateGroupContaining State Group states if the component is inside a state group, information about that group. It preserves the provider’s current classification of this record.

Enables: separate file component records by the exact provider-reported containing state group value when describing their recorded state.
Interpretation: The provider supplies containingStateGroup per containing frame record using its own state vocabulary; unknown and missing values must remain distinct.

Name

Developer identifier: file_components.containing_frame.containingStateGroup.nameName captures the name of the state group. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma file component record.
Interpretation: The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: file_components.containing_frame.containingStateGroup.nodeIdNode ID captures the node ID of the state group. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies nodeId as a record-level identifier on ContainingStateGroup. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: file_components.containing_frame.nameName captures the name of the containing frame. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma file component record.
Interpretation: The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: file_components.containing_frame.nodeIdNode ID captures the node ID of the containing frame. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies nodeId as a record-level identifier on ContainingFrame. It is not a uniqueness guarantee unless a connector directive says so.

Page ID

Developer identifier: file_components.containing_frame.pageIdPage ID captures the node ID of the page that contains this frame. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same page ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies pageId as a record-level identifier on ContainingFrame. It is not a uniqueness guarantee unless a connector directive says so.

Page Name

Developer identifier: file_components.containing_frame.pageNamePage Name captures the name of the page that contains this frame. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact page name returned for each Figma file component record.
Interpretation: The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.

Created At

Developer identifier: file_components.created_atCreated At records ISO 8601 timestamp indicating when the component was first created. It anchors the named event or boundary on the record’s timeline.

Enables: place file component records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per file component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: file_components.descriptionDescription contains a human-readable description of the component. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description returned for each Figma file component record.
Interpretation: The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.

File Key

Developer identifier: file_components.file_keyFile Key captures the key of the Figma file containing this component. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on FileComponent. It is not a uniqueness guarantee unless a connector directive says so.

Key

Developer identifier: file_components.keyKey is the unique component key that globally identifies this component. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same file component source row before constructing its represented state.
Interpretation: The provider supplies key at one value per file component record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: file_components.nameName captures the name of the component as displayed in Figma. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma file component record.
Interpretation: The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: file_components.node_idNode ID captures the node ID of this component within the file’s document tree. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on FileComponent. It is not a uniqueness guarantee unless a connector directive says so.

Thumbnail URL

Developer identifier: file_components.thumbnail_urlThumbnail URL records URL to a thumbnail image of the component. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a file component record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each file component record. Availability still follows the provider’s permissions and retention.

Updated At

Developer identifier: file_components.updated_atUpdated At records ISO 8601 timestamp indicating when the component was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place file component records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_at per file component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

User

Developer identifier: file_components.userUser captures the user who last modified or published this component. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the file component record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each file component record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: file_components.user.handleHandle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: file_components.user.idID is the unique identifier for the Figma user. It is needed to resolve references that repeat the same provider identifier.

Enables: match file component records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on User. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: file_components.user.img_urlImg URL records URL to the user’s profile image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each user record. Availability still follows the provider’s permissions and retention.

File Dev Resources

Developer identifier: file_dev_resourcesFile Dev Resources contain dev resources attached to a Figma file. Requires a file_key parent context.

Enables: trace developer-resource links attached to nodes in a specific file.
Scope: Reads the declared collection through GET /{apiVersion}/files/{key}/dev_resources as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Created At

Developer identifier: file_dev_resources.created_atCreated At records ISO 8601 timestamp of when the dev resource was created. It anchors the named event or boundary on the record’s timeline.

Enables: place file dev resource records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per dev resource record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Created By

Developer identifier: file_dev_resources.created_byCreated By captures the user who created this dev resource. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the dev resource record to the provider-reported person or account represented by created by.
Interpretation: The provider supplies created_by as identity or attribution context on each dev resource record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: file_dev_resources.created_by.handleHandle records display name / handle of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: file_dev_resources.created_by.idID is the unique user identifier. It is needed to resolve references that repeat the same provider identifier.

Enables: match file dev resource records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on User. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: file_dev_resources.created_by.img_urlImg URL records URL of the user’s profile image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each user record. Availability still follows the provider’s permissions and retention.

Dev Resource Type

Developer identifier: file_dev_resources.dev_resource_typeDev Resource Type captures the type/category of the dev resource. It preserves the provider’s current classification of this record.

Enables: separate file dev resource records by the exact provider-reported dev resource type value when describing their recorded state.
Interpretation: The provider supplies dev_resource_type per dev resource record using its own state vocabulary; unknown and missing values must remain distinct.

File Key

Developer identifier: file_dev_resources.file_keyFile Key captures the key of the Figma file this dev resource belongs to. It is needed to resolve references that repeat the same provider identifier.

Enables: match file dev resource records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on DevResource. It is not a uniqueness guarantee unless a connector directive says so.

Developer identifier: file_dev_resources.idID is the unique identifier for the dev resource. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same dev resource source row before constructing its represented state.
Interpretation: The provider supplies id at one value per dev resource record, and x-transformDedupKey explicitly marks it as the record key.

Inherited From

Developer identifier: file_dev_resources.inherited_fromInherited From identifies the component or instance from which the development resource inherits. It preserves the source relationship needed to explain inherited resource metadata.

Enables: follow the inheritance link back to its source component or instance and distinguish inherited resources from directly defined ones.
Interpretation: The provider returns inherited_from as a nested source reference on DevResource; absence means no inheritance source was reported on that resource.

File Key

Developer identifier: file_dev_resources.inherited_from.file_keyFile Key captures the file key of the source file from which the dev resource was inherited. It is needed to resolve references that repeat the same provider identifier.

Enables: match file dev resource records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on InheritedFrom. It is not a uniqueness guarantee unless a connector directive says so.

Node ID

Developer identifier: file_dev_resources.inherited_from.node_idNode ID captures the node ID in the source file from which the dev resource was inherited. It is needed to resolve references that repeat the same provider identifier.

Enables: match file dev resource records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on InheritedFrom. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: file_dev_resources.nameName records display name of the dev resource. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma file dev resource record.
Interpretation: The value covers only the file dev resources content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: file_dev_resources.node_idNode ID captures the ID of the node within the file that this dev resource is attached to. It is needed to resolve references that repeat the same provider identifier.

Enables: match file dev resource records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on DevResource. It is not a uniqueness guarantee unless a connector directive says so.

Updated At

Developer identifier: file_dev_resources.updated_atUpdated At records ISO 8601 timestamp of when the dev resource was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place file dev resource records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_at per dev resource record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

URL

Developer identifier: file_dev_resources.urlURL records URL of the external dev resource. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by URL on a dev resource record.
Interpretation: The provider supplies url as a URL or resource locator on each dev resource record. Availability still follows the provider’s permissions and retention.

File Styles

Developer identifier: file_stylesFile Styles contain all styles within a specific Figma file. Requires a file_key parent context.

Enables: inspect style definitions local to a specific design file.
Scope: Reads the declared collection through GET /{apiVersion}/files/{key}/styles as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Created At

Developer identifier: file_styles.created_atCreated At records ISO 8601 timestamp indicating when the style was created. It anchors the named event or boundary on the record’s timeline.

Enables: place file style records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per figma file style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: file_styles.descriptionDescription records description of the style provided by the designer. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description returned for each Figma file style record.
Interpretation: The value covers only the file styles content returned by this Figma operation; unrequested canvas content is not inferred.

File Key

Developer identifier: file_styles.file_keyFile Key captures the key of the Figma file that contains this style. It is needed to resolve references that repeat the same provider identifier.

Enables: match file style records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on FigmaFileStyle. It is not a uniqueness guarantee unless a connector directive says so.

Key

Developer identifier: file_styles.keyKey is the unique identifier key for the style. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same figma file style source row before constructing its represented state.
Interpretation: The provider supplies key at one value per figma file style record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: file_styles.nameName records human-readable name of the style. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma file style record.
Interpretation: The value covers only the file styles content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: file_styles.node_idNode ID captures the node ID within the file where this style is defined. It is needed to resolve references that repeat the same provider identifier.

Enables: match file style records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on FigmaFileStyle. It is not a uniqueness guarantee unless a connector directive says so.

Sort Position

Developer identifier: file_styles.sort_positionSort Position contains a string used for sorting the style within its category or file. It preserves the stated measure at this record’s granularity.

Enables: order or classify file style records using the provider-defined sort position value.
Interpretation: The provider supplies sort_position at figma file style granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Style Type

Developer identifier: file_styles.style_typeStyle Type captures the type of style (e.g., FILL, TEXT, EFFECT, GRID). It preserves the provider’s current classification of this record.

Enables: separate file style records by the exact provider-reported style type value when describing their recorded state.
Interpretation: The provider supplies style_type per figma file style record using its own state vocabulary; unknown and missing values must remain distinct.

Thumbnail URL

Developer identifier: file_styles.thumbnail_urlThumbnail URL records URL to a thumbnail image representing the style. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a figma file style record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each figma file style record. Availability still follows the provider’s permissions and retention.

Updated At

Developer identifier: file_styles.updated_atUpdated At records ISO 8601 timestamp indicating when the style was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place file style records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_at per figma file style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

User

Developer identifier: file_styles.userUser captures the user who last modified or published the style. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the figma file style record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each figma file style record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: file_styles.user.handleHandle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the figma user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each figma user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: file_styles.user.idID is the unique identifier of the Figma user. It is needed to resolve references that repeat the same provider identifier.

Enables: match file style records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on FigmaUser. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: file_styles.user.img_urlImg URL records URL to the user’s profile image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a figma user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each figma user record. Availability still follows the provider’s permissions and retention.

File Versions

Developer identifier: file_versionsFile Versions contain paginated version history for a Figma file. Requires a file_key parent context. Pagination uses next_page URL from the pagination object in the response.

Enables: reconstruct the version history returned for each design file.
Scope: Reads the declared collection through GET /{apiVersion}/files/{key}/versions as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Created At

Developer identifier: file_versions.created_atCreated At records ISO 8601 timestamp indicating when this version was created. It anchors the named event or boundary on the record’s timeline.

Enables: place file version records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per file version record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: file_versions.descriptionDescription records user-provided description for this version. May be empty if no description was set. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description returned for each Figma file version record.
Interpretation: The value covers only the file versions content returned by this Figma operation; unrequested canvas content is not inferred.

File Key

Developer identifier: file_versions.file_keyFile Key identifies parent key injected by the ingestor from the project_files to file_versions traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match file version records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on FileVersion. It is not a uniqueness guarantee unless a connector directive says so.

Developer identifier: file_versions.idID is the unique identifier for this file version. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same file version source row before constructing its represented state.
Interpretation: The provider supplies id at one value per file version record, and x-transformDedupKey explicitly marks it as the record key.

Label

Developer identifier: file_versions.labelLabel records user-assigned label or name for this version. May be empty if no label was set. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact label returned for each Figma file version record.
Interpretation: The value covers only the file versions content returned by this Figma operation; unrequested canvas content is not inferred.

Thumbnail URL

Developer identifier: file_versions.thumbnail_urlThumbnail URL records URL to a thumbnail image representing the file at this version. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a file version record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each file version record. Availability still follows the provider’s permissions and retention.

User

Developer identifier: file_versions.userUser captures the user who created or saved this version. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the file version record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each file version record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: file_versions.user.emailEmail records email address of the user. Typically only populated on the /v1/me endpoint; may be absent here. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the user record to the provider-reported person or account represented by email.
Interpretation: The provider supplies email as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: file_versions.user.handleHandle records display name or handle of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: file_versions.user.idID is the unique identifier for the Figma user. It is needed to resolve references that repeat the same provider identifier.

Enables: match file version records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on User. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: file_versions.user.img_urlImg URL records URL to the user’s profile avatar image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each user record. Availability still follows the provider’s permissions and retention.

Project Files

Developer identifier: project_filesProject Files contain all files within a Figma project. Requires a project_id parent context. Returns file key, name, thumbnail URL, and last modified timestamp.

Enables: catalog design files in each project with their names, thumbnails, and modification times.
Scope: Reads the declared collection through GET /{apiVersion}/projects/{id}/files as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Branches

Developer identifier: project_files.branchesBranches records list of branches for this file. Only present when branch_data query parameter is set to true. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested branches object into its declared child fields for each project file record.
Interpretation: The provider returns branches as a list on ProjectFile; an absent value does not prove that no related object exists outside the credential’s visibility.

Key

Developer identifier: project_files.branches.keyKey is the unique key identifier for the branch file. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same branch source row before constructing its represented state.
Interpretation: The provider supplies key at one value per branch record, and x-transformDedupKey explicitly marks it as the record key.

Last Modified

Developer identifier: project_files.branches.last_modifiedLast Modified records ISO 8601 timestamp indicating when the branch was last modified. It anchors the named event or boundary on the record’s timeline.

Enables: place project file records on a timeline by last modified and select the records within an explicit reporting window.
Interpretation: The provider supplies last_modified per branch record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Name

Developer identifier: project_files.branches.nameName captures the human-readable name of the branch. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma project file record.
Interpretation: The value covers only the project files content returned by this Figma operation; unrequested canvas content is not inferred.

Thumbnail URL

Developer identifier: project_files.branches.thumbnail_urlThumbnail URL records URL of the branch’s thumbnail image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a branch record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each branch record. Availability still follows the provider’s permissions and retention.

Key

Developer identifier: project_files.keyKey is the unique file key identifier used to reference this file across the Figma API. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same project file source row before constructing its represented state.
Interpretation: The provider supplies key at one value per project file record, and x-transformDedupKey explicitly marks it as the record key.

Last Modified

Developer identifier: project_files.last_modifiedLast Modified records ISO 8601 timestamp indicating when the file was last modified. It anchors the named event or boundary on the record’s timeline.

Enables: place project file records on a timeline by last modified and select the records within an explicit reporting window.
Interpretation: The provider supplies last_modified per project file record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Name

Developer identifier: project_files.nameName captures the human-readable name of the file. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma project file record.
Interpretation: The value covers only the project files content returned by this Figma operation; unrequested canvas content is not inferred.

Team ID

Developer identifier: project_files.team_idTeam ID identifies parent id injected by the ingestor from the team_projects to project_files traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match project file records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies team_id as a record-level identifier on ProjectFile. It is not a uniqueness guarantee unless a connector directive says so.

Thumbnail URL

Developer identifier: project_files.thumbnail_urlThumbnail URL records URL of the file’s thumbnail image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a project file record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each project file record. Availability still follows the provider’s permissions and retention.

Team Component Sets

Developer identifier: team_component_setsTeam Component Sets contain all published component sets for a Figma team. Cursor-based pagination using after parameter. Requires team_id parent context.

Enables: catalog published component families available from each team.
Scope: Reads the declared collection through GET /{apiVersion}/teams/{team_id}/component_sets as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Containing Frame

Developer identifier: team_component_sets.containing_frameContaining Frame records information about the frame that contains this component set in the file. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested containing frame object into its declared child fields for each team component set record.
Interpretation: The provider returns containing_frame as a nested object or reference on TeamComponentSet; an absent value does not prove that no related object exists outside the credential’s visibility.

Background Color

Developer identifier: team_component_sets.containing_frame.backgroundColorBackground Color records background color of the containing frame. It preserves the provider’s visual treatment for the represented object.

Enables: reproduce or compare the provider-supplied background color for the represented design or board object.
Interpretation: The provider supplies backgroundColor in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.

Containing State Group

Developer identifier: team_component_sets.containing_frame.containingStateGroupContaining State Group states if the component set is inside a state group, this describes that group. It preserves the provider’s current classification of this record.

Enables: separate team component set records by the exact provider-reported containing state group value when describing their recorded state.
Interpretation: The provider supplies containingStateGroup per containing frame record using its own state vocabulary; unknown and missing values must remain distinct.

Name

Developer identifier: team_component_sets.containing_frame.containingStateGroup.nameName captures the name of the containing state group. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team component set record.
Interpretation: The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_component_sets.containing_frame.containingStateGroup.nodeIdNode ID captures the node ID of the containing state group. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies nodeId as a record-level identifier on ContainingStateGroup. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: team_component_sets.containing_frame.nameName captures the name of the containing frame. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team component set record.
Interpretation: The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_component_sets.containing_frame.nodeIdNode ID captures the node ID of the containing frame. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies nodeId as a record-level identifier on ContainingFrame. It is not a uniqueness guarantee unless a connector directive says so.

Page ID

Developer identifier: team_component_sets.containing_frame.pageIdPage ID captures the node ID of the page that contains this frame. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same page ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies pageId as a record-level identifier on ContainingFrame. It is not a uniqueness guarantee unless a connector directive says so.

Page Name

Developer identifier: team_component_sets.containing_frame.pageNamePage Name captures the name of the page that contains this frame. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact page name returned for each Figma team component set record.
Interpretation: The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.

Created At

Developer identifier: team_component_sets.created_atCreated At records ISO 8601 timestamp indicating when this component set was created. It anchors the named event or boundary on the record’s timeline.

Enables: place team component set records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per team component set record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: team_component_sets.descriptionDescription contains a text description of the component set. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description returned for each Figma team component set record.
Interpretation: The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.

File Key

Developer identifier: team_component_sets.file_keyFile Key captures the key of the file that contains this component set. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on TeamComponentSet. It is not a uniqueness guarantee unless a connector directive says so.

Key

Developer identifier: team_component_sets.keyKey is the unique identifier key for this component set. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same team component set source row before constructing its represented state.
Interpretation: The provider supplies key at one value per team component set record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: team_component_sets.nameName captures the name of the component set. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team component set record.
Interpretation: The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_component_sets.node_idNode ID captures the node ID of this component set within its file. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on TeamComponentSet. It is not a uniqueness guarantee unless a connector directive says so.

Team ID

Developer identifier: team_component_sets.team_idTeam ID identifies team id injected by the ingestor from config fan-out parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies team_id as a record-level identifier on TeamComponentSet. It is not a uniqueness guarantee unless a connector directive says so.

Thumbnail URL

Developer identifier: team_component_sets.thumbnail_urlThumbnail URL records URL of the thumbnail image for this component set. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a team component set record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each team component set record. Availability still follows the provider’s permissions and retention.

Updated At

Developer identifier: team_component_sets.updated_atUpdated At records ISO 8601 timestamp indicating when this component set was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place team component set records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_at per team component set record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

User

Developer identifier: team_component_sets.userUser captures the user who last published this component set. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the team component set record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each team component set record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: team_component_sets.user.handleHandle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the figma user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each figma user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: team_component_sets.user.idID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component set records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on FigmaUser. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: team_component_sets.user.img_urlImg URL records URL of the user’s profile image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a figma user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each figma user record. Availability still follows the provider’s permissions and retention.

Team Components

Developer identifier: team_componentsTeam Components contain all published components for a Figma team. Cursor-based pagination using after parameter. Requires team_id parent context.

Enables: catalog published components available from each team.
Scope: Reads the declared collection through GET /{apiVersion}/teams/{team_id}/components as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Component Set ID

Developer identifier: team_components.component_set_idComponent Set ID identifies if this component is part of a component set (variants), the ID of the parent component set. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same component set ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies component_set_id as a record-level identifier on TeamComponent. It is not a uniqueness guarantee unless a connector directive says so.

Component Set Name

Developer identifier: team_components.component_set_nameComponent Set Name records if this component is part of a component set, the name of the parent component set. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact component set name returned for each Figma team component record.
Interpretation: The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.

Containing Frame

Developer identifier: team_components.containing_frameContaining Frame records information about the frame that contains this component in the file. It preserves the containing or referenced object needed to reconstruct the provider relationship.

Enables: expand the nested containing frame object into its declared child fields for each team component record.
Interpretation: The provider returns containing_frame as a nested object or reference on TeamComponent; an absent value does not prove that no related object exists outside the credential’s visibility.

Background Color

Developer identifier: team_components.containing_frame.backgroundColorBackground Color captures the background color of the containing frame. It preserves the provider’s visual treatment for the represented object.

Enables: reproduce or compare the provider-supplied background color for the represented design or board object.
Interpretation: The provider supplies backgroundColor in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.

Containing State Group

Developer identifier: team_components.containing_frame.containingStateGroupContaining State Group states if the component is inside a state group, information about that group. It preserves the provider’s current classification of this record.

Enables: separate team component records by the exact provider-reported containing state group value when describing their recorded state.
Interpretation: The provider supplies containingStateGroup per containing frame record using its own state vocabulary; unknown and missing values must remain distinct.

Name

Developer identifier: team_components.containing_frame.containingStateGroup.nameName captures the name of the state group. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team component record.
Interpretation: The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_components.containing_frame.containingStateGroup.nodeIdNode ID captures the node ID of the state group. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies nodeId as a record-level identifier on ContainingStateGroup. It is not a uniqueness guarantee unless a connector directive says so.

Name

Developer identifier: team_components.containing_frame.nameName captures the name of the containing frame. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team component record.
Interpretation: The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_components.containing_frame.nodeIdNode ID captures the node ID of the containing frame. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies nodeId as a record-level identifier on ContainingFrame. It is not a uniqueness guarantee unless a connector directive says so.

Page ID

Developer identifier: team_components.containing_frame.pageIdPage ID captures the node ID of the page that contains this frame. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same page ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies pageId as a record-level identifier on ContainingFrame. It is not a uniqueness guarantee unless a connector directive says so.

Page Name

Developer identifier: team_components.containing_frame.pageNamePage Name captures the name of the page that contains this frame. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact page name returned for each Figma team component record.
Interpretation: The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.

Created At

Developer identifier: team_components.created_atCreated At records ISO 8601 timestamp indicating when the component was first created/published. It anchors the named event or boundary on the record’s timeline.

Enables: place team component records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per team component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: team_components.descriptionDescription contains a text description of the component, typically set by the designer. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description returned for each Figma team component record.
Interpretation: The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.

File Key

Developer identifier: team_components.file_keyFile Key captures the key of the Figma file that contains this component. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on TeamComponent. It is not a uniqueness guarantee unless a connector directive says so.

Key

Developer identifier: team_components.keyKey is the unique identifier key for the component. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same team component source row before constructing its represented state.
Interpretation: The provider supplies key at one value per team component record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: team_components.nameName captures the display name of the component. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team component record.
Interpretation: The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_components.node_idNode ID captures the node ID of this component within its containing file. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on TeamComponent. It is not a uniqueness guarantee unless a connector directive says so.

Team ID

Developer identifier: team_components.team_idTeam ID identifies team id injected by the ingestor from config fan-out parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies team_id as a record-level identifier on TeamComponent. It is not a uniqueness guarantee unless a connector directive says so.

Thumbnail URL

Developer identifier: team_components.thumbnail_urlThumbnail URL records URL of the component’s thumbnail image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a team component record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each team component record. Availability still follows the provider’s permissions and retention.

Updated At

Developer identifier: team_components.updated_atUpdated At records ISO 8601 timestamp indicating when the component was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place team component records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_at per team component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

User

Developer identifier: team_components.userUser captures the user who last published or updated the component. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the team component record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each team component record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: team_components.user.handleHandle captures the user’s display name / handle. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the figma user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each figma user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: team_components.user.idID is the unique numeric identifier for the user, represented as a string. It is needed to resolve references that repeat the same provider identifier.

Enables: match team component records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on FigmaUser. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: team_components.user.img_urlImg URL records URL of the user’s profile image / avatar. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a figma user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each figma user record. Availability still follows the provider’s permissions and retention.

Team Projects

Developer identifier: team_projectsTeam Projects contain all projects within a Figma team. Requires a team_id parent context. Returns project id and name.

Enables: enumerate projects inside each configured Figma team.
Scope: Reads the declared collection through GET /{apiVersion}/teams/{team_id}/projects as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Developer identifier: team_projects.idID is the unique identifier for the project within Figma. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same team project source row before constructing its represented state.
Interpretation: The provider supplies id at one value per team project record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: team_projects.nameName records human-readable name of the project. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team project record.
Interpretation: The value covers only the team projects content returned by this Figma operation; unrequested canvas content is not inferred.

Team ID

Developer identifier: team_projects.team_idTeam ID identifies team id injected by the ingestor from config fan-out parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match team project records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies team_id as a record-level identifier on TeamProject. It is not a uniqueness guarantee unless a connector directive says so.

Team Styles

Developer identifier: team_stylesTeam Styles contain all published styles for a Figma team. Cursor-based pagination using after parameter. Requires team_id parent context.

Enables: catalog published styles available from each team.
Scope: Reads the declared collection through GET /{apiVersion}/teams/{team_id}/styles as a full snapshot. Results are limited by the token’s granted scopes and team resource allowlist; inaccessible files and teams are absent.

Created At

Developer identifier: team_styles.created_atCreated At records ISO 8601 timestamp indicating when the style was created. It anchors the named event or boundary on the record’s timeline.

Enables: place team style records on a timeline by created at and select the records within an explicit reporting window.
Interpretation: The provider supplies created_at per team style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

Description

Developer identifier: team_styles.descriptionDescription records description of the style provided by the creator. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact description returned for each Figma team style record.
Interpretation: The value covers only the team styles content returned by this Figma operation; unrequested canvas content is not inferred.

File Key

Developer identifier: team_styles.file_keyFile Key captures the key of the file that contains this style. It is needed to resolve references that repeat the same provider identifier.

Enables: match team style records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies file_key as a record-level identifier on TeamStyle. It is not a uniqueness guarantee unless a connector directive says so.

Key

Developer identifier: team_styles.keyKey is the unique style key that identifies this style across Figma. It supplies the declared record identity used when repeated ingestions represent the same source row.

Enables: recognize repeated ingestions of the same team style source row before constructing its represented state.
Interpretation: The provider supplies key at one value per team style record, and x-transformDedupKey explicitly marks it as the record key.

Name

Developer identifier: team_styles.nameName records human-readable name of the style. It keeps the exact text, label, or authored value needed to interpret the record.

Enables: inspect the exact name returned for each Figma team style record.
Interpretation: The value covers only the team styles content returned by this Figma operation; unrequested canvas content is not inferred.

Node ID

Developer identifier: team_styles.node_idNode ID captures the node ID within the file where this style is defined. It is needed to resolve references that repeat the same provider identifier.

Enables: match team style records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies node_id as a record-level identifier on TeamStyle. It is not a uniqueness guarantee unless a connector directive says so.

Sort Position

Developer identifier: team_styles.sort_positionSort Position reports sort position of the style. It preserves the stated measure at this record’s granularity.

Enables: order or classify team style records using the provider-defined sort position value.
Interpretation: The provider supplies sort_position at team style granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.

Style Type

Developer identifier: team_styles.style_typeStyle Type captures the type of the style (e.g., FILL, TEXT, EFFECT, GRID). It preserves the provider’s current classification of this record.

Enables: separate team style records by the exact provider-reported style type value when describing their recorded state.
Interpretation: The provider supplies style_type per team style record using its own state vocabulary; unknown and missing values must remain distinct.

Team ID

Developer identifier: team_styles.team_idTeam ID identifies team id injected by the ingestor from config fan-out parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.

Enables: match team style records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies team_id as a record-level identifier on TeamStyle. It is not a uniqueness guarantee unless a connector directive says so.

Thumbnail URL

Developer identifier: team_styles.thumbnail_urlThumbnail URL records URL to a thumbnail image representing this style. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by thumbnail URL on a team style record.
Interpretation: The provider supplies thumbnail_url as a URL or resource locator on each team style record. Availability still follows the provider’s permissions and retention.

Updated At

Developer identifier: team_styles.updated_atUpdated At records ISO 8601 timestamp indicating when the style was last updated. It anchors the named event or boundary on the record’s timeline.

Enables: place team style records on a timeline by updated at and select the records within an explicit reporting window.
Interpretation: The provider supplies updated_at per team style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.

User

Developer identifier: team_styles.userUser captures the user who published or last updated this style. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the team style record to the provider-reported actor represented by user.
Interpretation: The provider supplies user as identity or attribution context on each team style record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Handle

Developer identifier: team_styles.user.handleHandle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.

Enables: attribute the style user record to the provider-reported person or account represented by handle.
Interpretation: The provider supplies handle as identity or attribution context on each style user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.

Developer identifier: team_styles.user.idID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.

Enables: match team style records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
Interpretation: The provider supplies id as a record-level identifier on StyleUser. It is not a uniqueness guarantee unless a connector directive says so.

Img URL

Developer identifier: team_styles.user.img_urlImg URL records URL to the user’s avatar image. It retains the exact provider location for the referenced resource.

Enables: open or trace the exact provider resource referenced by img URL on a style user record.
Interpretation: The provider supplies img_url as a URL or resource locator on each style user record. Availability still follows the provider’s permissions and retention.

Error	Meaning	Solution
`403 Invalid token`	Bad PAT, or PAT was revoked	Re-mint from Figma Settings → Security; confirm minting user is still active
`403 Invalid scope`	PAT missing a required scope	Re-mint with the full scope list above
`404 Not found` on a file or team	Minting user lacks access	Add service-account user to the team, or remove the missing resource
`403` on a Plan Access Token	Team is outside the token’s resource allowlist	Edit the token at figma.com/developers/tokens and add the team, or allow all resources
`404` / `403` on `/v1/me`	Expected for a Plan Access Token	`/v1/me` is not supported for plan tokens; verify against `/v1/teams/{id}/projects` instead
`429 Too many requests`	Rate limit exceeded	Parable respects `Retry-After` and backs off automatically
`Activity logs return empty`	Tap is disabled by default	Enable the `activity_logs` tap in Provider settings; requires Enterprise plan and org admin access

Common Issues

Token works in curl but the Provider reports invalid

Confirm you copied the full token string — Figma PATs are 40+ characters and may contain hyphens. Trailing whitespace from a paste also fails; re-paste into the Provider form.

`activity_logs` returns 402 / `payment_required`

Activity logs are an Enterprise-only feature and are disabled by default. Enable the activity_logs tap only on Enterprise plans with org admin access.Figma REST API — Full endpoint referencePersonal access tokens — Official PAT setup guide including scope semantics

​Design assets

​Activity & admin

​Data streams

​Figma

​What You’ll Need

​Step 1: Open Figma Security settings

​Step 2: Generate the token

​Step 3: Enter values in the form

​Common Issues

​Token works in curl but the Provider reports invalid

​activity_logs returns 402 / payment_required

Design assets

Activity & admin

Data streams

Figma

What You’ll Need

Step 1: Open Figma Security settings

Step 2: Generate the token

Step 3: Enter values in the form

Common Issues

Token works in curl but the Provider reports invalid

`activity_logs` returns 402 / `payment_required`