List the dashboard's notifications, newest first

The account's events in the categories the dashboard shows, newest first, each with whether it is read. Free.

Auth: the dashboard session cookie.

Example

cURL

curl 'https://staging.socialtap.dev/v1/notifications' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

The dashboard's session cookie, not an API key.

Query parameters

Name	Type	Description	Example
`limit` optional	`integer` min 1 max 100	Notifications per page (default and maximum 100).	—
`cursor` optional	`string` max 200 chars	page.next_cursor of the previous page; omit to start from the newest.	—

limitintegermin 1max 100

Notifications per page (default and maximum 100).

cursorstringmax 200 chars

page.next_cursor of the previous page; omit to start from the newest.

Response

application/json

200

List the dashboard's notifications, newest first

Field	Type	Description
`data`	`object[]`	This page's items.
`data[].category`	`string`	The event type's notification category (catalog notification_categories). One of `credits`, `spend_limits`, `jobs`, `api_keys`, `webhooks`
`data[].event`	`object`	The event, exactly as GET /v1/events/{id} answers it.
`data[].event.data`	`any`	The type's data object (small: a summary plus links).
`data[].event.id`	`string`	The event ID (evt_…): the webhook-id header of every delivery, the same on retries. Deduplicate on it.
`data[].event.object`	`string`	Always event. One of `event`
`data[].event.timestamp`	`string` (date-time)	When it happened.
`data[].event.type`	`string`	The event type (event types table); new types may be added.
`data[].object`	`string`	Always notification. One of `notification`
`data[].read`	`boolean`	Whether it is at or before the read marker (POST /v1/notifications/read).
`meta`	`object`	The shared route meta (see the API reference introduction).
`page`	`object`
`page.end_reason`	`string` or `null`	Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is. One of `end`, `platform_limit`, `max_pages`
`page.has_more`	`boolean`	True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
`page.next_cursor`	`string` or `null`	Pass as cursor, with the same other parameters, to get the next page; null at the end.
`page.next_cursor_expires_at`	`string` (date-time) or `null`	When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

dataobject[]

This page's items.

Show 4 child fields

categorystring

The event type's notification category (catalog notification_categories).

One ofcreditsspend_limitsjobsapi_keyswebhooks

eventobject

The event, exactly as GET /v1/events/{id} answers it.

Show 5 child fields

dataany

The type's data object (small: a summary plus links).

idstring

The event ID (evt_…): the webhook-id header of every delivery, the same on retries. Deduplicate on it.

objectstring

Always event.

One ofevent

timestampstring date-time

When it happened.

typestring

The event type (event types table); new types may be added.

objectstring

Always notification.

One ofnotification

readboolean

Whether it is at or before the read marker (POST /v1/notifications/read).

metaobject

The shared route meta (see the API reference introduction).

pageobject

Show 4 child fields

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

400

400 Bad Request.

Code	HTTP	Retry	Meaning	What to do
`invalid_input`	400	No	The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.	Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.
`invalid_cursor`	400	No	The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it.	Repeat the original request without cursor to start the list again.

invalid_inputNo retry

The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.

Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

invalid_cursorNo retry

The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized.

Code	HTTP	Retry	Meaning	What to do
`unauthorized`	401	No	The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).	Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

unauthorizedNo retry

The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).

Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

403

403 Forbidden.

Code	HTTP	Retry	Meaning	What to do
`forbidden`	403	No	The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include; or the request used a rotated key's previous secret (or one no longer current) for something that needs the admin scope. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.	Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope) or the key's new secret after a rotation, have the owner confirm the emailed link, create a new key, or call from an allowed IP.

forbiddenNo retry

The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include; or the request used a rotated key's previous secret (or one no longer current) for something that needs the admin scope. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.

Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope) or the key's new secret after a rotation, have the owner confirm the emailed link, create a new key, or call from an allowed IP.

429

429 Too Many Requests.

Code	HTTP	Retry	Meaning	What to do
`rate_limited`	429	Yes, later	The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.	Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

rate_limitedYes, later

The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.

Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

operationId notifications.list