Skip to main content
GET
Fetch Comment by Foreign ID
Returns a single comment matching the given foreignId within the project. Useful for looking up comments using your own application’s identifiers.

Query Parameters

foreignId
string
required
The foreign ID to look up.
include
string
Comma-separated list of associations to include. Valid values: user, entity, space, parent.

Response

Returns a 200 OK with the following shape:
The comment field is a Comment object. If the comment has been removed (user-deleted or moderation-removed) and the viewer is not the author, identifying fields (userId, user, content, gif, mentions, attachments) are nulled out as a Reddit-style placeholder.

Error Responses