List the signed-in user's notifications
Returns a page of the caller's own inbox, optionally filtered to one workspace or to account notices (workspaceId=none), going back only as far as the plan...
GET/api/v1/public/notifications
- Sign-in
- A signed-in user's session: send the session id in the x-session-id header.
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).
Returns a page of the caller's own inbox, optionally filtered to one workspace or to account notices (workspaceId=none), going back only as far as the plan keeps email history. Items of a workspace whose rules refuse this session are left out, or answered 403 when filtered to that workspace; 503 policy_unavailable when that cannot be decided.
Request
This operation takes no parameters and no body.
Example request
Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.
curl -X GET "https://api.console.buildbase.app/api/v1/public/notifications" \
-H "x-session-id: $BUILDBASE_SESSION_ID"const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/notifications',
{
method: 'GET',
headers: {
'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
},
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import os
import requests
response = requests.get(
"https://api.console.buildbase.app/api/v1/public/notifications",
headers={
"x-session-id": os.environ["BUILDBASE_SESSION_ID"],
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"hasNextPage": false,
"limit": 20,
"notifications": [
{
"archivedAt": null,
"body": "Registered by its first send from the SDK.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "none"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "m22_workspace_note",
"icon": null,
"id": "000000000000000000000001",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "custom",
"title": "A note in Globex design 1767225600000",
"url": null,
"workspaceId": "000000000000000000000002"
},
{
"archivedAt": null,
"body": "Registered by its first send from the SDK.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "none"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "m22_workspace_note",
"icon": null,
"id": "000000000000000000000003",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "custom",
"title": "A note in Globex finance 1767225600000",
"url": null,
"workspaceId": "000000000000000000000004"
},
{
"archivedAt": null,
"body": "Your account signed in from a new device. If this wasn't you, secure your account.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "sent"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "user.new_device_login",
"icon": null,
"id": "000000000000000000000005",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "New device signed in",
"url": null,
"workspaceId": null
},
{
"archivedAt": null,
"body": "Your account was just signed in.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "none"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "user.logged_in",
"icon": null,
"id": "000000000000000000000006",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "New sign-in",
"url": null,
"workspaceId": null
},
{
"archivedAt": null,
"body": "Your account signed in from a new device. If this wasn't you, secure your account.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "sent"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "user.new_device_login",
"icon": null,
"id": "000000000000000000000007",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "New device signed in",
"url": null,
"workspaceId": null
},
{
"archivedAt": null,
"body": "Your account was just signed in.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "none"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "user.logged_in",
"icon": null,
"id": "000000000000000000000008",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "New sign-in",
"url": null,
"workspaceId": null
},
{
"archivedAt": null,
"body": "Session User wsgate-owner added you to Globex finance 1767225600000 as viewer.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "sent"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "workspace.member_added",
"icon": null,
"id": "000000000000000000000009",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "Workspace Invitation",
"url": null,
"workspaceId": "000000000000000000000004"
},
{
"archivedAt": null,
"body": "Session User wsgate-owner added you to Globex support 1767225600000 as viewer.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "sent"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "workspace.member_added",
"icon": null,
"id": "000000000000000000000010",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "Workspace Invitation",
"url": null,
"workspaceId": "000000000000000000000011"
},
{
"archivedAt": null,
"body": "Session User wsgate-owner added you to wsgate 1767225600000 as viewer.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "sent"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "workspace.member_added",
"icon": null,
"id": "000000000000000000000012",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "Workspace Invitation",
"url": null,
"workspaceId": "000000000000000000000002"
},
{
"archivedAt": null,
"body": "Your account signed in from a new device. If this wasn't you, secure your account.",
"channels": {
"email": {
"clickedAt": null,
"openedAt": null,
"status": "sent"
},
"push": {
"clickedAt": null,
"status": "none"
}
},
"createdAt": "2026-01-01T00:00:00.000Z",
"event": "user.new_device_login",
"icon": null,
"id": "000000000000000000000013",
"link": null,
"readAt": null,
"readVia": null,
"seenAt": null,
"source": "system",
"title": "New device signed in",
"url": null,
"workspaceId": null
}
],
"page": 1,
"total": 12
}Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
401 Unauthorized
What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.
What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.
Unauthorized429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Notifications guide: how this part of BuildBase works
- All Notifications operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
notifications.listin public-v1.json