Skip to content

Area: Developers

GET

List inbox messages

Path
/inbox/messages
Auth
Access token · browser or app
GET
/inbox/messages
curl --request GET \
--url 'https://releva.ai/api/v0/inbox/messages?userId=DEMO-CUSTOMER-1001&limit=20' \
--header 'Authorization: Bearer <token>'

Returns the shopper’s active, unexpired messages, newest first. Use nextCursor to fetch the next page; it is null on the last page. Deleted and expired messages are never returned.

userId
required
string
>= 1 characters <= 96 characters

The shopper’s profile id (the value the app passed to setProfileId).

limit
integer
default: 20 >= 1 <= 50

Page size. Default 20, maximum 50 (larger values are capped). 0 or a non-numeric value means 20. Negative values currently cause a 500; send a value from 1 to 50.

cursor
string

The nextCursor value from the previous page. Opaque. An invalid cursor is ignored and the first page is returned.

One page of messages.

Media typeapplication/json
object
messages
required
Array<object>
object
id
required

Message (delivery) id. Use it in the read

string format: uuid
title
required

Title

string
design
required

Message body as Unlayer design JSON, personalised when the message was sent. Render it with the SDK.

object | null
read
required
boolean
createdAt
required

When the message was delivered.

string format: date-time
inboxMessageId
required

Id of the message template. The same for every shopper who got this message; push payloads refer to it.

integer
nextCursor
required

Pass as cursor to get the next page. null on the last page.

string | null

Example

{
"messages": [
{
"id": "fe9db61a-b2ef-491e-bae7-e96735072932",
"title": "Summer sale starts today",
"design": {
"body": {
"id": "demo",
"rows": [
{
"id": "row-1",
"cells": [
1
],
"values": {},
"columns": [
{
"id": "col-1",
"values": {},
"contents": [
{
"id": "text-1",
"type": "text",
"values": {
"text": "<p>Take 20% off linen shirts until Sunday.</p>"
}
}
]
}
]
}
],
"values": {}
},
"counters": {},
"schemaVersion": 16
},
"read": false,
"createdAt": "2026-10-21T19:18:20.804Z",
"inboxMessageId": 2
}
],
"nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTEwLTIxVDE5OjE4OjIwLjgwNFoiLCJpZCI6ImZlOWRiNjFhLWIyZWYtNDkxZS1iYWU3LWU5NjczNTA3MjkzMiJ9"
}

Authentication error, or userId missing or longer than 96 characters.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Authorization header is missing",
"and accessToken url parameters is also missing. At least one of them is required.": null
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

Unexpected error. Currently also returned for malformed input: a messageId that is not a UUID, a userId that is not a string, userId only in the query string of a POST or DELETE, or a negative limit.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}