Skip to content

Get in-app notifications for a user

GET
/user/inapp
before
string

Timestamp or ISO date to fetch notifications before

count
number

Number of notifications to return (default 10)

Successful response

object
notifications
required
Array<object>
object
id
required
string
notificationId
required
string
subNotificationId
string
seen
required
boolean
title
required
string
redirectURL
string
imageURL
string
deliveryOptions
object
defaultDeliveryOption
required
string
Allowed values: off instant
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
batching
boolean
batchingKey
string
batchingWindow
number
template
Any of:
object
envId
required
string
notificationId
required
string
templateId
required
string
channel
required
string
Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK
default
required
boolean
isDefaultFor
object
key
additional properties
boolean
parameters
object
key
additional properties
date
required
string
opened
string
clicked
string
archived
string
actioned1
string
actioned2
string
replies
Array<object>
object
date
required
string
message
required
string
expDate
string

Bad Request - validation errors, invalid input

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string

Unauthorized

Payment Required - usage limits exceeded

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string

Internal Server Error

Bad Gateway - provider error

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string