Skip to main content
Help Centers

Get a collection by ID

Retrieves a specific collection by its unique identifier.

GET
/v2/help_center/collections/{id}

Returns the collection object if found in your organization's help center.

Response

Returns a collection object with:

  • id - Unique identifier
  • name - Collection name
  • description - Collection description
  • slug - URL slug
  • icon - Collection icon (emoji or custom)
  • parentId - Parent collection ID (null for root collections)
  • helpCenterId - ID of the help center this collection belongs to
  • organization - Organization ID
  • defaultLocale - Default locale for content
  • locale - Current locale
  • availableLocales - Array of available locales
  • featurebaseUrl - Featurebase URL for the collection
  • externalUrl - External URL if custom domain is configured
  • articleCount - Number of articles in this collection
  • authorCount - Number of authors who contributed
  • order - Display order
  • translations - Translations for different locales
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated

Errors

  • 404 - Collection not found in your organization's help center

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

Collection unique identifier

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: 6474684

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

articleCountnumber

Number of articles

Example: 15
authorCountnumber

Number of authors

Example: 3
availableLocalesenum<string>[]required

Available locales

collapseSidebarboolean

Whether to collapse sidebar

Example: false
createdAtstringrequired

ISO 8601 timestamp when created

Example: 2024-10-18T12:33:09.099Z
defaultLocaleenum<string>

Default locale

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, bn, bs, pt-BR, bg, ca, hr, cs, da, nl, en, et, fi, fr, de, el, hi, hu, id, it, ja, ko, lv, lt, ms, mn, nb, pl, pt, ro, ru, sr, zh-CN, sk, sl, es, sw, sv, th, zh-TW, tr, uk, vi
Example: en
descriptionstring

Collection description

Example: A description in English
externalUrlstring

External URL

Example: https://help.yourdomain.com/en/collections/6474684-english-version
featurebaseUrlstring

Featurebase URL

Example: https://yourorg.featurebase.app/en/help/collections/6474684-english-version
helpCenterIdstringrequired

Help center ID

Example: j7c5g8ah3ewxp4lo
iconobject | null

Collection icon

idstringrequired

Collection unique identifier

Example: 6474684
localeenum<string>required

Current locale

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, bn, bs, pt-BR, bg, ca, hr, cs, da, nl, en, et, fi, fr, de, el, hi, hu, id, it, ja, ko, lv, lt, ms, mn, nb, pl, pt, ro, ru, sr, zh-CN, sk, sl, es, sw, sv, th, zh-TW, tr, uk, vi
Example: en
namestring

Collection name

Example: English Collection Name
objectenum<string>required

Object type identifier

Available options: collection
Example: collection
ordernumber | null

Display order

Example: 1
organizationstringrequired

Organization ID

Example: 6595518396205e06b897ad65
parentIdstring | nullrequired

Parent collection ID

pathstring

Collection path

Example: ox6qrqprmsuqaunj/3876752/3513543
slugstring

URL slug

Example: 6474684-english-version
translationsobject

Translations by locale code

updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: 2024-10-18T13:03:25.921Z

Still need help? Ask the team