Tolgee Octri Demo
GET/v2/notification

List notifications for the authenticated user

Lists notifications for the authenticated user, with the newest notifications first. Use filterSeen to include only seen or unseen notifications, and use cursor or the page parameters to navigate the results. The response includes page metadata and a nextCursor when another result page is available.

5 parameters
pageintegeroptional
Zero-based page index. Must be 0 or greater. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of notifications per page. Must be at least 1. Defaults to 20 when omitted.
Default:20
sortarray<string>optional
Sort criteria in `property,(asc|desc)` format; you can provide multiple criteria. Defaults to ascending order when no direction is specified.
filterSeenbooleanoptional
Filter notifications by whether they have been seen: `true` for seen, `false` for unseen, or omit to include both.
cursorstringoptional
Cursor for continuing from a previous notification response. Omit to start without a cursor.

5 status codes
200Returns notification items with page metadata and a `nextCursor` for retrieving the next set of results.
_embeddedobjectoptional
nextCursorstringoptional
Cursor to get next data
pageobjectoptional
pagedModelobjectoptional
400Returned when a query value is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when access to the requested operation is forbidden.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the requested resource is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 indicates a query value is invalid; a 401 indicates authentication is missing or invalid; a 403 indicates access is forbidden; and a 404 indicates the requested resource was not found. page must be zero or greater, and size must be at least 1; filterSeen accepts true or false.