Retrieve a help collection

Look up a single help collection by its UUID, including how many categories it contains.

Returns a single help collection, scoped to the authenticated organization. A collection belonging to another organization returns 404, identically to one that doesn't exist.

Endpoint

POST https://api.productbridge.io/api/external/v1/help-collections/retrieve

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

collection_idstring

Required

UUID of the collection to retrieve.

Returns

A help collection object.

Example request

curl -X POST https://api.productbridge.io/api/external/v1/help-collections/retrieve \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "collection_id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb"
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/help-collections/retrieve",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      collection_id: "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
    }),
  }
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const collection = await res.json();

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/help-collections/retrieve",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "collection_id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
    },
)
resp.raise_for_status()
collection = resp.json()

Example response

{
  "id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
  "name": "Getting Started",
  "slug": "getting-started",
  "description": "Set up your account and learn the basics.",
  "icon": "rocket",
  "color": "#4E938A",
  "seq_number": "1000.0000",
  "category_count": 4,
  "created_at": "2026-08-01T10:12:00",
  "updated_at": "2026-08-04T09:30:00"
}

To list the categories counted by category_count, call List categories with this collection_id.

Errors

Status	Body	Cause
`401`	`{"detail":{"error":"invalid api_key"}}`	Missing / unknown / inactive `api_key`.
`403`	`{"detail":{"error":"The Help Center is not enabled on your current plan..."}}`	Your plan does not include the `knowledgebase` feature.
`404`	`{"detail":{"error":"help collection not found"}}`	No such collection, or it belongs to another organization.
`422`	Validation error envelope	`collection_id` missing or not a valid UUID.

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

Was this page helpful?