Fetch Comment by Foreign ID
Comment Endpoints
Fetch Comment by Foreign ID
Get a comment by its foreign ID
Fetch Comment by Foreign ID
Returns a single comment matching the given
The
foreignId within the project. Useful for looking up comments using your own application’s identifiers.
If the comment author is block-edged with the signed-in caller, in either
direction, this returns
404 with comment/not-found — identical to a
comment that does not exist. An embedded parentComment is nulled under the
same rule. Requires the moderation bundle.Query Parameters
string
required
The foreign ID to look up.
string
Comma-separated list of associations to include. Valid values:
user, entity, space, parent, grants (the reputation-grant summary).Response
Returns a200 OK with the following shape:
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.
This endpoint nests the record under a
comment key, unlike every other read surface, which returns the record bare. So a requested grants summary lives at comment.grants — see GrantSummary.Error Responses
Not Found — 404
Not Found — 404

