Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Topics

List Topics

Topics are the categories of questions that can be asked about a Brand Kit. They are used to group questions together and to create a taxonomy of questions.

post/public_api/brand_kits/{brand_kit_id}/topics/list

Path parameters

brand_kit_idinteger required

The Brand Kit ID

Request body

brand_kit_idinteger required

The ID of the Brand Kit

fieldsstring[]

Select additional fields to return.

Optional fields:

  • id: Unique identifier for the topic
  • name: The topic name
  • color: The topic color (hex code)
sort'name' | '-name' | 'created_at' | '-created_at'

Sort field. Prefix with - for descending.

Available sort fields:

  • name/-name: Sort alphabetically by topic name
  • created_at/-created_at: Sort by creation date
pageinteger

Page number

per_pageinteger

Items per page

Response

Successful response