Help Center API reference

Help Center endpoints of the Quackback REST API: paths, parameters, request fields and responses.

JM
James Morton
Written By James MortonLast updated 3 days ago

This is the reference for the Help Center endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

  • GET /help-center/categories: List help center categories
  • POST /help-center/categories: Create a help center category
  • GET /help-center/categories/{categoryId}: Get a help center category
  • PATCH /help-center/categories/{categoryId}: Update a help center category
  • DELETE /help-center/categories/{categoryId}: Delete a help center category
  • GET /help-center/articles: List help center articles
  • POST /help-center/articles: Create a help center article
  • GET /help-center/articles/{articleId}: Get a help center article
  • PATCH /help-center/articles/{articleId}: Update a help center article
  • DELETE /help-center/articles/{articleId}: Delete a help center article
  • POST /help-center/articles/{articleId}/feedback: Record article feedback

List help center categories

GET /api/v1/help-center/categories

Returns every category with its article count.

Response 200: returns id, slug, name, description, icon, parentId, isPublic, position, createdAt, updatedAt, articleCount.

Create a help center category

POST /api/v1/help-center/categories

Requires the help_center.manage permission.

Request body

Field

Type

Required

Description

name

string

Yes

slug

string

No

Generated from the name when omitted

description

string

No

isPublic

boolean

No

position

integer

No

parentId

string, nullable

No

TypeID - a type-prefixed UUID

icon

string, nullable

No

Response 201: returns id, slug, name, description, icon, parentId, isPublic, position, createdAt, updatedAt.

Get a help center category

GET /api/v1/help-center/categories/{categoryId}

Parameters

Name

In

Type

Required

Description

categoryId

path

string

Yes

Help center category ID

Response 200: returns id, slug, name, description, icon, parentId, isPublic, position, createdAt, updatedAt.

Update a help center category

PATCH /api/v1/help-center/categories/{categoryId}

Requires the help_center.manage permission.

Parameters

Name

In

Type

Required

Description

categoryId

path

string

Yes

Help center category ID

Request body

Field

Type

Required

Description

name

string

No

slug

string

No

description

string, nullable

No

isPublic

boolean

No

position

integer

No

parentId

string, nullable

No

TypeID - a type-prefixed UUID

icon

string, nullable

No

Response 200: returns id, slug, name, description, icon, parentId, isPublic, position, createdAt, updatedAt.

Delete a help center category

DELETE /api/v1/help-center/categories/{categoryId}

Requires the help_center.manage permission.

Parameters

Name

In

Type

Required

Description

categoryId

path

string

Yes

Help center category ID

List help center articles

GET /api/v1/help-center/articles

Returns articles newest first, with cursor pagination.

Parameters

Name

In

Type

Required

Description

categoryId

query

string

No

Only articles in this category

status

query

string (draft, published, all)

No

Filter by publish state

search

query

string

No

Text to match against the title and body

cursor

query

string

No

Cursor from meta.pagination.cursor

limit

query

integer

No

Items per page

Response 200: returns id, slug, title, description, content, publishedAt, viewCount, helpfulCount, notHelpfulCount, createdAt, updatedAt, category, author.

Create a help center article

POST /api/v1/help-center/articles

Creates a draft article. Requires the help_center.manage permission.

Request body

Field

Type

Required

Description

categoryId

string

Yes

Category the article belongs to

title

string

Yes

content

string

Yes

Article body as markdown

slug

string

No

Generated from the title when omitted

description

string

No

authorId

string

Yes

Principal ID of the team member credited as the author. Required, because API keys act as a service identity rather than a person.

Response 201: returns id, slug, title, description, content, publishedAt, viewCount, helpfulCount, notHelpfulCount, createdAt, updatedAt, category, author.

Get a help center article

GET /api/v1/help-center/articles/{articleId}

Parameters

Name

In

Type

Required

Description

articleId

path

string

Yes

Help center article ID

Response 200: returns id, slug, title, description, content, publishedAt, viewCount, helpfulCount, notHelpfulCount, createdAt, updatedAt, category, author.

Update a help center article

PATCH /api/v1/help-center/articles/{articleId}

Updates fields and, through publishedAt, the publish state. Requires the help_center.manage permission.

Parameters

Name

In

Type

Required

Description

articleId

path

string

Yes

Help center article ID

Request body

Field

Type

Required

Description

categoryId

string

No

TypeID - a type-prefixed UUID

title

string

No

content

string

No

Article body as markdown

slug

string

No

description

string

No

publishedAt

string, nullable

No

authorId

string

No

TypeID - a type-prefixed UUID

Response 200: returns id, slug, title, description, content, publishedAt, viewCount, helpfulCount, notHelpfulCount, createdAt, updatedAt, category, author.

Delete a help center article

DELETE /api/v1/help-center/articles/{articleId}

Soft deletes the article. Requires the help_center.manage permission.

Parameters

Name

In

Type

Required

Description

articleId

path

string

Yes

Help center article ID

Record article feedback

POST /api/v1/help-center/articles/{articleId}/feedback

Records whether the article was helpful, on behalf of the API key owner.

Parameters

Name

In

Type

Required

Description

articleId

path

string

Yes

Help center article ID

Request body

Field

Type

Required

Description

helpful

boolean

Yes

Whether the article was helpful

Response 200: returns success.

Was this helpful?

Your feedback shapes what we write next.

← Previous

Webhooks API reference

Next →

Segments API reference

Related articles

Posts API referencePosts endpoints of the Quackback REST API: paths, parameters, request fields and responses.Comments API referenceComments endpoints of the Quackback REST API: paths, parameters, request fields and responses.API overviewCreate an API key, authenticate to the REST API, and learn the base URL, errors, pagination and rate limits. Full endpoint reference lives at /api/v1/docs.Users API referenceUsers endpoints of the Quackback REST API: paths, parameters, request fields and responses.