userportal-public

Get Categories

Get all categories for a product.

Product is identified by domain or F1-Product header. Used in the public userportal to display category filters.

Returns categories with:

  • id: Category ID
  • name/caption: Category name
  • color: Hex color code for UI display
  • createdDate: When the category was created
  • lastEditDate: When the category was last modified
get/userportal/categories

Request

  • Base URL: https://api.feedback1.ai/api/v1
  • URL: https://api.feedback1.ai/api/v1/userportal/categories
  • Auth: none declared

Headers

F1-Productstring

Response

Successful Response

idstring required

Category ID

namestring required

Category name

captionstring required

Category name (legacy alias)

colorstring required

Hex color code (e.g., #FF5733)

createdDatestring date-time required

When the category was created

lastEditDatestring date-time nullable

When the category was last modified

Example response

[
  {
    "caption": "API",
    "color": "#7268A6",
    "createdDate": "2022-09-14T19:50:50.613Z",
    "id": "category_2bk8sjc6g1l2k1q",
    "lastEditDate": "2022-09-14T19:50:50.613Z",
    "name": "API"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.