GET
/
v5
/
app
/
notification_topics
curl --request GET \
  --url https://{defaultHost}/v5/app/notification_topics \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "app_id": "<string>",
      "created_at": 123,
      "name": "<string>",
      "description": "<string>",
      "notification_channel_identifiers": [
        "email"
      ],
      "status": "active",
      "topic_identifier": "<string>",
      "topic_type": "company",
      "visibility": "visible"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
status
enum<string>

A status to filter by.

Available options:
active,
inactive
​
topic_type
enum<string>

A topic type to filter by.

Available options:
company,
user
​
notification_channel_identifiers
enum<string>[]
Available options:
email,
sms,
in_app,
discord_dm,
mobile
​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json
notification topics retrieved
​
pagination
object
required
​
data
object[]
required

Was this page helpful?

Create a Notification TopicRetrieve a Notification Topic