Skip to main content
GET
List notifications

Authorizations

X-API-KEY
string
header
required

Query Parameters

recipientId
string

Filter by recipient user ID. Defaults to the authenticated user when omitted.

recipientClientId
string

Filter by recipient client ID.

recipientInternalUserId
string

Filter by recipient internal user ID.

includeRead
boolean
default:false

Include read notifications in the response.

recipientCompanyId
string

Filter by recipient company ID.

limit
integer

Maximum number of records to return.

nextToken
string

Pagination cursor returned by a previous request.

Response

OK

data
object[]
nextToken
string

base64 encoded JSON representing a NextToken