Ir al contenido principal
Help Centers

Get a help center by ID

Retrieves a single help center by its unique identifier.

GET
/v2/help_center/help_centers/{id}

Returns the help center object if found in your organization.

Response

Returns a help center object with:

  • id - Unique identifier
  • displayName - Help center display name
  • title - Help center title
  • description - Help center description
  • searchPlaceholder - Search input placeholder text
  • isPublic - Whether the help center is publicly accessible
  • defaultLocale - Default locale for content
  • locale - Current locale
  • availableLocales - Array of available locales
  • navItems - Navigation items configuration
  • urls - URL configuration (subpath, custom domain)
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated

Errors

  • 404 - Help center not found in your organization

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

Help center unique identifier

Required string length: 1 - 16
Patrón: ^[a-zA-Z0-9]+$
Ejemplo: 2tgy0ig982j54qfl

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Ejemplo: 2026-08-19.orbit

Respuesta

application/json

Success

availableLocalesenum<string>[]obligatorio

Available locales

createdAtstringobligatorio

ISO 8601 timestamp when created

Ejemplo: 2024-06-26T13:27:21.920Z
defaultLocaleenum<string>obligatorio

Default locale for the help center

Opciones disponibles: 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
Ejemplo: en
descriptionstring

Help center description

Ejemplo:
displayNamestring

Help center display name

Ejemplo: Your Help Center
externalLinksOpenInNewTabboolean

Whether external links in articles open in a new tab

Ejemplo: true
hideAuthorInfoboolean

Whether to hide author info on articles

Ejemplo: false
hideDateInfoboolean

Whether to hide date info on articles

Ejemplo: false
idstringobligatorio

Help center unique identifier

Ejemplo: 2tgy0ig982j54qfl
internalLinksOpenInNewTabboolean

Whether internal links in articles open in a new tab

Ejemplo: false
isPublicbooleanobligatorio

Whether the help center is public

Ejemplo: true
localeenum<string>obligatorio

Current locale

Opciones disponibles: 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
Ejemplo: en
navItemsobject[]

Navigation items

Campos anidados no mostrados
objectenum<string>obligatorio

Object type identifier

Opciones disponibles: help_center
Ejemplo: help_center
organizationstringobligatorio

Organization ID

Ejemplo: 6595518396205e06b897ad65
searchPlaceholderstring

Search input placeholder

Ejemplo: Search for help...
titlestring

Help center title

Ejemplo: Help Center
translationsobject

Translations for different locales

updatedAtstringobligatorio

ISO 8601 timestamp when last updated

Ejemplo: 2024-06-26T13:52:19.415Z
urlsobject

URLs configuration

¿Aún necesitas ayuda? Pregunta al equipo