Skip to main content

JSON file schema

The files provided by the Discovery API are in JSON format and represented as an array of JSON objects. The following table describes the objects that can appear in the array.

NameDescription

file_key​

String
A unique identifier for the file where the text communication took place.

text​

String
The text itself that was communicated.

timestamp​

Number
A unix timestamp with second level precision representing when the text communication occurred.

action_type​

String

The action performed that resulted in text communication, as a string enum.

  • insert
  • update
  • delete
  • transient

file_name​

String
The file name at the time text communication took place.

file_workspace_id​

String | null
The ID of the workspace the file belonged to at time of text communication. Can be null if the file is not in a workspace.

node_id​

String | null
The identifier for the entity within Figma that the text belongs to. This value is unique within a file, but could be the same value in a different file.

text_type​

String

What object type within Figma that text belongs to, as a string enum. See text types for more details.

Note: It's possible that new values will be added for this enum. When building with this API, keep in mind that the list of valid values might expand.

  • in_file
  • file_comments
  • file_comment_reactions
  • developer_related_links
  • dev_mode_annotation
  • component_documentation_link
  • component_documentation_description
  • cursor_chat
  • user_ai_prompts

resource_id​

String | null

A unique identifier, valid for the following text_type values:

  • file_comments
  • file_comment_reactions
  • developer_related_links
  • user_ai_prompts

parent_comment_id​

String | null

A unique identifier for a resource’s parent comment, valid for the following text_type values:

  • file_comments
  • file_comment_reactions

user_id​

String
A unique identifier for the user who performed the text communication.

user_email​

String
The user’s email at the time text communication took place. When a user is in a FigJam open session but not logged in, will be marked as anonymous.

user_billing_group_id​

String | null
The ID of the billing group the user belonged to at time of text communication. Can be null if the user is not in a billing group.

feature_entrypoint​

String | null

The UI feature or entry point from which the action was performed. Valid for the following text_type values:

  • user_ai_prompts

moderation_failure_flags​

String | null

Content moderation flags, if any were triggered. Null or empty when moderation passed. Valid for the following text_type values:

  • user_ai_prompts