Retrieve a category

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

Retrieves the details of an existing category, specified by its id. The category must belong to the authenticated organization — passing a UUID that exists in another org returns 404 not found.

Endpoint

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

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

idstring

Required

The category's UUID.

Returns

A category 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/categories/retrieve \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb"
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/categories/retrieve",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      id: "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
    }),
  }
);
if (res.status === 404) throw new Error("Category not found in this organization");
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const category = await res.json();

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/categories/retrieve",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
    },
)
if resp.status_code == 404:
    raise LookupError("Category not found in this organization")
resp.raise_for_status()
category = resp.json()

Example response

{
  "id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
  "name": "UI",
  "code": "ui",
  "description": "User interface and visual design feedback.",
  "color": "#3B82F6",
  "show_on_feedback": true,
  "show_on_roadmap": true,
  "created_at": "2026-05-09T13:14:22.389Z"
}

Errors

Status	Body	Cause
`401`	`{"detail":{"error":"invalid api_key"}}`	Missing / unknown / inactive `api_key`.
`404`	`{"detail":{"error":"category not found"}}`	The id doesn't exist, has been deleted, or belongs to a different organization.
`422`	Validation error envelope	Missing `id`, or `id` is not a UUID.

See Errors for the full envelope shape and a recommended client-side handler.

Was this page helpful?

Last updated 2 weeks ago

Built with Documentation.AI