headless lms

List the notification types a category list can cover

GET /api/notification-types. List the notification types a category list can cover. Headless LMS Notifications API reference.

GET
/api/notification-types

Requires one of notification_categories:read, communities:read. scope=org lists the types the org list can cover and needs notification_categories:read; scope=community lists those a community list can cover and also takes communities:read on any community. Each type carries all its scopes, so an editor can tell which types can be per space.

Query Parameters

scope*string

Value in

  • "org"
  • "community"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/notification-types?scope=org"
[  {    "type": "string",    "scopes": [      "org"    ],    "reasons": [      "subject"    ]  }]
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}