Skip to main content
GET
Get Comment by Foreign ID
Fetches a single comment using its foreignId. Optionally returns the parent comment if it exists and withParent=true is passed. This is useful when using a custom identifier set by the client, instead of the internal comment ID.

Query Parameters

foreignId
string
required
The external reference ID used to identify a comment
withParent
string
If true, includes the parent comment in the response

Response

comment
object
parentComment
object
Parent comment object (null if no parent or withParent not set)

Error Responses


Notes

  • Requires a valid foreignId to locate the comment.
  • Set withParent=true to include the parent comment.
  • Returns parentComment: null if there is no parent or it’s not requested.