Get a list of notifications

get

https://api.pushologies.com/v1/notifications

Retrieves a list of notifications.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

10 to 500

Defaults to 100

Number of items to retrieve with this API request (default is 100, minimum - 10 per page, maximum - 500).

offset

integer

0 to 10000000

Defaults to 0

A cursor on where to start returning the amount of items specified in query parameter (defaults to 0).

title

string

Filter notifications by either title or subTitle fields. Must be uri encoded string

createdById

string

Filter notifications by user who created it. Id needs to match ids from /users endpoint

includeCreatedByData

boolean

Prefill the createdBy field of each notification row with the data of the tenant user who created the notification

pushed

boolean

Filter notifications by if they're pushed or not

createdAfter

date-time

Filter notifications by those created after date given in ISO 8601 format.. Needs to be accompanied by a createdBefore query parameter as well.

createdBefore

date-time

Filter notifications by those created before date given in ISO 8601 format.. Needs to be accompanied by a createdAfter query parameter as well.

types[]

string

enum

Filter by content item presentation by using a query parameter array e.g. "/notifications?types[]=VIDEO&types[]=STANDARD"

Allowed:

showHidden

boolean

Defaults to false

Include notifications that have been hidden. By default these are excluded.

Responses

401

Id Token or X-API-Key/X-API-Secret is missing or invalid.

403

The server understood the request but refuses to authorize it. In most cases due to insufficient user permissions.

200Array of notification objects

400Bad Request