GET
List my notifications
Company space For: Everyone Conditions
  • Company routes only (company session required); no permission is needed.
  • Only notifications addressed to the signed-in actor are returned: for a member, the user-global ones (system security notifications) plus those of the active profile; for an agent account, those of the agent account.
  • status defaults to unread; all also returns read notifications. per_page defaults to 15 with a maximum of 100; sort_by only accepts created_at and sort_order defaults to desc.
Part of Your account and notifications.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string> | null

Which notifications to list: unread (default) keeps only unread ones, all also returns read ones.

Available options:
all,
unread
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
sort_by
enum<string> | null

Only created_at: cursor pagination needs a stable, non-null ordering key, and read_at is nullable (all unread rows share NULL), which breaks cursor ordering.

Available options:
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, type, data, read_at, created_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
InAppNotificationResource · object[]
required

Items of this page.

meta
object
required

Pagination details.