Help Center API Reference

List endpoints

Lists the endpoints of a version: method, path, stableKey, operationId, summary, tag, and hasIntro (an intro exists). Use it to find the stableKey (and operationId) to send to PUT …/intros. Search with q (method, path, summary, operationId) or filter by tag.

GET

/v2/help_center/api_specs/{specId}/endpoints

List endpoints

curl --request GET \
  --url 'https://do.featurebase.app/v2/help_center/api_specs/{specId}/endpoints?revision=live&tag=Posts&q=post&limit=100&cursor=eyJpbmRleCI6MTAwfQ' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "data": [
    {
      "deprecated": false,
      "hasIntro": false,
      "hidden": false,
      "method": "POST",
      "object": "help_center_api_endpoint",
      "operationId": "createComment",
      "pagePath": "api-reference/comments/create-comment",
      "path": "/posts/{postId}/comments",
      "stableKey": "POST /posts/{}/comments",
      "summary": "Create a comment",
      "tag": "Comments",
      "tagSlug": "comments"
    }
  ],
  "nextCursor": null,
  "object": "list",
  "revision": 7
}

By default it lists the live (published) endpoints; revision=draft lists the draft that waits for review. A version with no live revision (or no ready draft) returns an empty list with revision: null.

Endpoint pages come from the spec: to change an endpoint, edit the spec and import it again. With this API you can only add an intro to an endpoint (PUT …/intros).

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

specIdstringrequired

The API reference version (id from the list).

Example: 66f7d0c1a2b3c4d5e6f70812

Query Parameters

revisionenum<string>query

live (default): the published endpoints. draft: the endpoints of the draft that waits for review.

Available options: live, draft

Example: live

tagstringquery

Only endpoints in this tag (the tag name or its URL slug, case-insensitive).

Required string length: 1 - 200

Example: Posts

qstringquery

Case-insensitive search in the method, path, stableKey, summary and operationId.

Required string length: 1 - 200

Example: post

limitintegerquerydefault:100

Number of endpoints to return (1-500).

Required range: 1 <= x <= 500

Example: 100

cursorstringquery

Opaque cursor from nextCursor.

Maximum string length: 512

Example: eyJpbmRleCI6MTAwfQ

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

Success

dataobject[]required

Endpoints in sidebar order (tag by tag).

Show child attributes

nextCursorstring | nullrequired

Cursor for the next page. Null if there are no more results.

objectenum<string>required

Available options: list

Example: list

revisioninteger | nullrequired

The revision listed. Null when the version has no live revision (or no ready draft); data is then empty.

Example: 7

Still need help? Ask the team