Issue: client_meta Returning Null in Comment API Response

REST API
1

I’ve encountered an issue while working with the Figma Comments API, and I’m wondering if anyone else has experienced something similar or has insights to share.

The Problem

When fetching comment data, I sometimes receive a null value for the client_meta field in the API response. This occurs inconsistently, making it challenging to rely on this field for certain functionalities in my application.

Example Response

Here’s a sanitized example of a comment object where client_meta is null:

{
  "id": "XXXXXXXXX",
  "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "file_key": "xxxxxxxxxxxxxxxxxxx",
  "parent_id": "XXXXXXXXX",
  "user": {
    "handle": "John Doe",
    "img_url": "https://www.gravatar.com/avatar/xxxxxxxxxxxxxxxxxxxx?size=240&default=https%3A%2F%2Fs3-alpha.figma.com%2Fstatic%2Fuser_s_v2.png",
    "id": "XXXXXXXXXXXXXXXXXXX"
  },
  "created_at": "2024-XX-XXT11:13:04.947Z",
  "resolved_at": null,
  "message": "Sample comment message",
  "reactions": [],
  **"client_meta": null,**
  "order_id": null
}

Questions

  1. Is this expected behavior in certain circumstances?
  2. Are there specific conditions under which client_meta might be null?
  3. Has anyone found a reliable way to ensure client_meta is always populated?

Impact

This inconsistency affects our ability to:

  • Accurately link comments to specific elements in the Figma file
  • Provide precise context for comments in our external tools

Any insights, workarounds, or official information about this issue would be greatly appreciated. Thanks in advance for your help!

Note to Figma team: If this is a known issue or expected behavior, it would be helpful to have it documented in the API reference.