Skip to content
Notavia Notavia Docs

List notification categories

GET
/v1/preferences/categories
 
curl --request GET \
  --url 'https://your-notavia-host/v1/preferences/categories?include_archived=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
include_archived
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Categories list.

Media type application/json
object
data
Array<object>
object
id
string format: uuid
key
string
name
string
description
string
nullable
is_critical
boolean
default_channels
Array<string>
Allowed values: email in_app webhook sms slack teams discord
default_opt_in
boolean
is_archived
boolean
Example 
{
  "data": [
    {
      "default_channels": [
        "email"
      ]
    }
  ]
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}