Skip to main content
Help Centers

List articles

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

GET
/v2/help_center/articles

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

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

limitintegerquerydefault:10

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

Required range: 1 <= x <= 100
Example: 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
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
stateenum<string>querydefault:live

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

Available options: live, draft, all
Example: live
parentIdstringquery

Filter articles by parent collection ID

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

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

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

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

dataobject[]required

Array of article objects

nextCursorstring | nullrequired

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

Example: eyJpZCI6IjY3NDM3NTJjYTgxYWU1OWQyNWNmODM0YiJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team