Help Centers

List articles

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

GET

/v2/help_center/articles

List articles

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

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

Articles are the main content pieces that contain documentation, guides, and FAQs.

Query Parameters

limit - Number of items to return (1-100, default 10)
cursor - Cursor for pagination
state - Filter by article state: "live", "draft", or "all" (default "live")
parentId - Filter by parent collection ID

Response Format

Returns a list object with:

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

Article Object

Each article includes:

id - Unique identifier
title - Article title
description - Article description
body - Article content (HTML)
slug - URL slug
icon - Article icon (emoji or custom)
parentId - Parent collection ID
helpCenterId - ID of the help center this article belongs to
organization - Organization ID
state - Article state (live or draft)
defaultLocale - Default locale for content
locale - Current locale
availableLocales - Array of available locales
publishedLocales - Array of locales where article is published
featurebaseUrl - Featurebase URL for the article
externalUrl - External URL if custom domain is configured
author - Author information (name, authorId, avatarUrl)
order - Display order
isPublished - Whether the article is published
isDraftDiffersFromLive - Whether draft differs from live version
translations - Translations for different locales
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated
liveUpdatedAt - ISO 8601 timestamp when live version was 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 of results.

Maximum string length: 512

Ejemplo: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9

stateenum<string>querydefault:live

Filter articles by state. Use "all" to get both draft and live articles.

Opciones disponibles: live, draft, all

Ejemplo: live

parentIdstringquery

Filter articles by parent collection ID

Required string length: 1 - 16

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

Ejemplo: 6474684

helpCenterIdstringquery

Filter articles by help center ID. If omitted, returns articles 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 article objects

Mostrar child attributes

nextCursorstring | nullobligatorio

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

Ejemplo: eyJpZCI6IjY3NDM3NTJjYTgxYWU1OWQyNWNmODM0YiJ9

objectenum<string>obligatorio

Object type identifier

Opciones disponibles: list

Ejemplo: list

¿Aún necesitas ayuda? Pregunta al equipo