Skip to main content
GET
/
insights
/
categories
Get categories
curl --request GET \
  --url https://api.open.cx/insights/categories \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
type
enum<string>
Available options:
base,
suggested,
user_defined
​
search
string

Case-insensitive keyword match on category name or description.

Response

Default Response

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
name
string
required
​
description
string | null
required
​
type
enum<string>
required
Available options:
base,
suggested,
user_defined