Skip to content
Adversarial

list notifications for user

GET
/v1/notifications

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer format: int64
default: 1 >= 1 <= 1000000

1-indexed page number. Defaults to 1; zero is rejected.

page_size
integer format: int64
default: 20 >= 1 <= 100

Rows per page. Defaults to 20; zero is rejected.

include_read
boolean
default: true

Whether to include read notifications. Defaults to true.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successfully retrieved list of notifications

The standard { results, pagination } envelope plus the bell-badge unread count, which spans all pages and ignores the include_read filter.

object
pagination
required

Pagination metadata describing the slice.

object
page
required

1-indexed page number of this result slice.

integer format: int64
page_size
required

Number of items requested per page.

integer format: int64
total_items
required

Total number of matching items across all pages.

integer format: int64
total_pages
required

Total number of pages at this page size.

integer format: int64
results
required

The items on this page.

Array<object>
object
contributor
required

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object
email
required
string
first_name
required
string
icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null
id
required
string format: uuid
last_name
required
string
details
string | null
id
required
integer format: int64
item_identifier
required
string
item_title
string | null
link
required
string
notification_text
required
string
notification_type
required
string
Allowed values: AssignedRisk RiskChanged NewRiskComment NewLowRisk NewMediumRisk NewHighRisk NewCriticalRisk IncChanged NewSev1Inc NewSev2Inc NewSev3Inc NewFraudInc NewExtortionInc NewSabotageInc NewDataDisclosureInc NewCustomerTargetingInc NewResourceHijackingInc NewIncComment AssignedInc DowngradedInc InvitedToOrg RisksCreated IncidentsCreated
read_at
string | null format: date-time
timestamp
required
string format: date-time
total_unread
required
integer format: int64

401

Section titled “401 ”

Unauthorized

404

Section titled “404 ”

Could not retrieve notifications