User Notifications

List notifications for a user

Returns the in-portal notifications for the Extole portal user identified by userId, sorted newest first. Requires the USER_SUPPORT scope. Use the limit and offset parameters to page through results.

get/v6/notifications/{userId}

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v6/notifications/:userId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

Query parameters

limitinteger

offsetinteger

having_all_tagsstring[]

event_idstring

subscription_idstring

Response

Notifications for the user.

cause_event_idstring required

cause_user_idstring required

channelsstring[] required

client_idstring required

client_versioninteger required

dataobject required

event_idstring required

event_timestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

level'ERROR' | 'INFO' | 'WARN' required

messagestring required

namestring required

snooze_idstring required

subscription_dedupe_duration_msinteger required

subscription_idstring required

tagsstring[] required

user_idstring required

Example response

[
  {
    "event_time": "2025-10-24T02:00:00-07:00"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.