List all Notifications

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

reference

string

optional

A string that will filter the notifications based on the title. The filter is case-insensitive and partial matches are allowed.

scope

string

optional

The scope of the notifications: When the scope query parameter is set to 'desktop', the notifications will be limited to 10. For any other value of the scope query parameter, the notifications will be limited to 100.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

array of:

id

integer

required

ID of the notification

action_type

string

required

The type of action associated with the notification

title

string

required

The title of the notification

target_type

string

required

The type of the target entity related to the notification

target_id

integer

required

The ID of the target entity

target_class_name

string

required

The class name of the target entity

sender_id

integer

required

The ID of the sender

sender_name

string

required

The name of the sender

sender_avatar_url

string

required

The URL of the sender's avatar image

object_url

string

required

The URL related to the object of the notification

created_at

string <date-time>

required

The timestamp when the notification was created.

is_it_read?

boolean

required

Indicates whether the notification has been read by the user

Example

[
    {
        "id": 0,
        "action_type": "string",
        "title": "string",
        "target_type": "string",
        "target_id": 0,
        "target_class_name": "string",
        "sender_id": 0,
        "sender_name": "string",
        "sender_avatar_url": "string",
        "object_url": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "is_it_read?": true
    }
]

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found