Retrieve a comment

Look up the full details of a single comment by its id, scoped to the authenticated organization.

Retrieves the details of an existing comment, specified by its id. The comment must belong to the authenticated organization.

Endpoint

POST https://api.productbridge.io/api/external/v1/comments/retrieve

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

idstring

Required

The comment's UUID.

Returns

A comment object on success, or a 404 error envelope when the id doesn't exist for this organization.

Example request

curl -X POST https://api.productbridge.io/api/external/v1/comments/retrieve \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "id": "ee3c3ef8-b8cd-cd15-01ba-comment000001"
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/comments/retrieve",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      id: "ee3c3ef8-b8cd-cd15-01ba-comment000001",
    }),
  }
);
if (res.status === 404) throw new Error("Comment not found");
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const comment = await res.json();

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/comments/retrieve",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "id": "ee3c3ef8-b8cd-cd15-01ba-comment000001",
    },
)
if resp.status_code == 404:
    raise LookupError("Comment not found")
resp.raise_for_status()
comment = resp.json()

Example response

{
  "id": "ee3c3ef8-b8cd-cd15-01ba-comment000001",
  "content": "+1 from the entire data team. We'd use this daily.",
  "author_id": "bb3c3ef8-b8cd-cd15-01ba-useruser0001",
  "parent_comment_id": null,
  "feedback_post_id": "aa3c3ef8-b8cd-cd15-01ba-postpost0001",
  "visibility_code": "public",
  "moderation_status_code": "accepted",
  "created_at": "2026-04-16T10:00:00.000Z",
  "updated_at": "2026-04-16T10:00:00.000Z"
}

Errors

Status	Body	Cause
`401`	`{"detail":{"error":"invalid api_key"}}`	Missing / unknown / inactive `api_key`.
`404`	`{"detail":{"error":"comment not found"}}`	Wrong id, deleted, or different organization.
`422`	Validation error envelope	Missing `id`, or `id` is not a UUID.

See Errors for the full envelope shape.

Was this page helpful?

Last updated 1 week ago

Built with Documentation.AI