Help Centers

List collections

Returns a paginated list of collections within your organization's help center.

GET

/v2/help_center/collections

List collections

curl --request GET \
  --url 'https://do.featurebase.app/v2/help_center/collections?limit=10&cursor=eyJpZCI6IjY0NzQ2ODQifQ&helpCenterId=h7l3snparrtl08hn' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "data": [],
  "nextCursor": null,
  "object": "list"
}

Collections are used to organize articles into logical groups.

Query Parameters

limit - Number of items to return (1-100, default 10)
cursor - Cursor for pagination

Response Format

Returns a list object with:

object - Always "list"
data - Array of collection objects
nextCursor - Cursor for next page (null if no more results)

Collection Object

Each collection includes:

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

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de consulta

limitintegerquerydefault:10

A limit on the number of objects to be returned, between 1 and 100.

Rango requerido: 1 <= x <= 100

Ejemplo: 10

cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page.

Maximum string length: 512

Ejemplo: eyJpZCI6IjY0NzQ2ODQifQ

helpCenterIdstringquery

Filter collections by help center ID. If omitted, returns collections across all help centers.

Required string length: 1 - 16

Patrón: ^[a-zA-Z0-9]+$

Ejemplo: h7l3snparrtl08hn

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

Success

dataobject[]obligatorio

Array of collections

Mostrar child attributes

nextCursorstring | nullobligatorio

Cursor for fetching the next page (cursor-based pagination)

objectenum<string>obligatorio

Object type identifier

Opciones disponibles: list

Ejemplo: list

¿Aún necesitas ayuda? Pregunta al equipo