Scenario Description

Currently, when using the Get Inline Comment by ID REST API endpoint for a Page or Blogpost, the response includes the ID for either the page or blogpost where the inline comment was created. However, when performing an API call with the same endpoint for a Whiteboard or a Database, the respective IDs (whiteboardId or databaseId) are not included in the response.

Currently, when using the REST API Endpoint for a Page or Blogpost, the response includes the ID for either the page or blogpost where the inline comment was created:

However, when performing an API Call with the same endpoint for a Whiteboard, the Whiteboard ID is not included in the response:

Suggested Solution

Include both the Whiteboard ID and Database ID in the API call response when the Get Inline Comment by ID endpoint is used for inline comments present in a Whiteboard or a Database.

Why This Is Important

Including these IDs is important to maintain consistency across different types of content when using the API. It allows developers to easily identify the content associated with inline comments without needing additional workarounds.

Workaround

Currently, although the API does not directly return the whiteboardId or databaseId when fetching inline comments, you can extract these IDs from the webui link found in the API response. The _links field contains a webui property, which includes the URL for the specific comment. This URL contains the ID of the whiteboard or database, allowing users to identify the origin of the comment.