Returns all notifications that the user has access to

1 minute(s) read

Prev Next

Get

/notifications

Display a listing of the resource.

Security

OAuth

Laravel passport oauth2 security.

FlowAuthorization Code

Authorization URLhttp://processmaker.test/oauth/authorize

Token URLhttp://processmaker.test/oauth/token

Refresh URLhttp://processmaker.test/token/refresh

HTTP

Type bearer

Query parameters

status

string

Only return notifications by status (unread, all, etc.)

filter

string

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_by

string

Field to order results by

order_direction

string

Valid values[ "asc", "desc" ]

Default"asc"

per_page

integer

Default10

include

string

Include data from related models in payload. Comma separated list.

Default""

Responses

200

list of notifications

Expand All

object

data

Array of object (Notification)

object

type

string

Represents a notification definition.

notifiable_type

string

notifiable_id

integer

data

string

name

string

message

string

processName

string

userName

string

request_id

string

url

string

read_at

string (date-time)

created_at

string (date-time)

updated_at

string (date-time)