/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference List In-App Messages

List In-App Messages

The account reminders and other messages waiting to be shown to you in the dashboard.

GET/v1/me/lifecycle/messagesTry it
Session token

Returns the messages queued for you as in-app messages — the card at the top of dashboard pages. Syntext queues a message here instead of emailing it when you've used the dashboard in the last day, or when your address can't receive mail. See In-app messages.

Only your own messages are returned, oldest first, at most five. A message stays in the list until you mark it seen with Mark In-App Message Seen. The dashboard shows the newest one.

Note

Requires a session JWT — a dashboard session or an stx login token. API keys are rejected with 401. Any plan.

Response — 200 OK

An empty array when nothing is waiting.

NameDescription
id:stringbody
The message id, for Mark In-App Message Seen.
journey:stringbody
What the message is about — for example unverified, never_deployed, failing_site, repo_access_lost, plan_limits, unpublished_changes or invite_pending. See Account reminders for the situations.
step:numberbody
Which reminder in that situation's schedule this is, from 1.
title:stringbody
The heading to show.
body:stringbody
One short paragraph.
cta:object | nullbody
The button: label and url. A url on app.syntext.dev opens in the dashboard; anything else is an external link.
createdAt:stringbody
When the message was queued.

Error Responses

401 Unauthorized

unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/me/lifecycle/messages \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": [
{
"id": "3b8f2c41-9d6e-4a17-b0c5-7e21f4a9d8c3",
"journey": "failing_site",
"step": 1,
"title": "Acme API failed to deploy",
"body": "Your live site still shows the last good version.",
"cta": {
"label": "Open the build log",
"url": "https://app.syntext.dev/projects/5c1e7a90-2f4b-4d38-9a61-0b7e3d2c8f15/deployments/e4a9c7b2-1d3f-4e8a-b6c0-9f2d5a7e1b34"
},
"createdAt": "2026-11-14T10:15:00.000Z"
}
]
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext