Retrieve a help article

Get one help article in full — HTML body, breadcrumbs, engagement counts, and curated related links.

Returns a single help article with its complete content. This is the only endpoint that returns the article body — List and Search omit content so a page response can't grow unbounded.

Endpoint

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

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

article_idstring

Required

UUID of the article to retrieve.

Returns

A help article object plus the following detail-only fields:

contentstring

The article body as HTML. May be null for an article created without one.

author_idstring

UUID of the article's author. May be null.

collectionobject

The article's collection, for breadcrumbs. Always present, whether the article is filed directly in a collection or inside one of its categories.

categoryobject

The article's category, for breadcrumbs. null when the article is filed directly in a collection.

related_articlesarray

Required

The curated related-article links, in their display order. Empty array when none are set.

Example request

curl -X POST https://api.productbridge.io/api/external/v1/help-articles/retrieve \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "article_id": "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb"
  }'

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

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/help-articles/retrieve",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "article_id": "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb",
    },
)
resp.raise_for_status()
article = resp.json()

Example response

{
  "id": "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb",
  "collection_id": null,
  "category_id": "884c3ef8-b8cd-cd15-01ba-44bb44bb44bb",
  "title": "Reset your password",
  "content": "<p>From the sign-in screen, choose <strong>Forgot password</strong> and follow the emailed link.</p>",
  "slug": "reset-your-password",
  "excerpt": "How to reset your password from the sign-in screen.",
  "status_code": "published",
  "show_on_portal": true,
  "favourite": false,
  "seq_number": "1000.0000",
  "helpful_count": 42,
  "not_helpful_count": 3,
  "view_count": 512,
  "author_id": "3f2c3ef8-b8cd-cd15-01ba-11bb11bb11bb",
  "published_at": "2026-08-02T11:00:00Z",
  "created_at": "2026-08-01T10:20:00",
  "updated_at": "2026-08-05T14:02:00",
  "collection": {
    "id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
    "name": "Getting Started",
    "slug": "getting-started"
  },
  "category": {
    "id": "884c3ef8-b8cd-cd15-01ba-44bb44bb44bb",
    "name": "Account",
    "slug": "account",
    "collection_id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb"
  },
  "related_articles": [
    {
      "id": "bb2c3ef8-b8cd-cd15-01ba-88bb88bb88bb",
      "title": "Change your email address",
      "slug": "change-your-email-address",
      "status_code": "published",
      "show_on_portal": true
    }
  ]
}

Building the public URL

The embedded collection and category give you every segment without extra calls:

function helpArticleUrl(article, portalOrigin) {
  const parts = [article.collection.slug];
  if (article.category) parts.push(article.category.slug);
  parts.push(article.slug);
  return `${portalOrigin}/help/${parts.join("/")}`;
}
// → https://feedback.acme.com/help/getting-started/account/reset-your-password

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 article not found"}}`	No such article, or it belongs to another organization.
`422`	Validation error envelope	`article_id` missing or not a valid UUID.

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

Was this page helpful?