Notifications

Count unread notifications

GET /v1/notifications/summary

How many notifications are unread, and the read marker. Free.

Auth: the dashboard session cookie.

Example

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

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

Response

application/json

200

Count unread notifications

FieldTypeDescription
dataobject
data.objectstringAlways notification_summary.
One of notification_summary
data.read_throughstring or nullThe newest event marked read (evt_…); null until one is. It may have expired since: events are kept events_retention_s.
data.unread_countintegerEvents after the read marker in the categories the dashboard shows (in_app on), counted up to 100.
metaobjectThe shared route meta (see the API reference introduction).
dataobject
ShowHide 3 child fields
objectstring

Always notification_summary.

One ofnotification_summary

read_throughstringnullable

The newest event marked read (evt_…); null until one is. It may have expired since: events are kept events_retention_s.

unread_countinteger

Events after the read marker in the categories the dashboard shows (in_app on), counted up to 100.

metaobject

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

400

400 Bad Request.

CodeHTTPRetryMeaningWhat to do
invalid_input400NoThe 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.

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.

401

401 Unauthorized.

CodeHTTPRetryMeaningWhat to do
unauthorized401NoThe 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.

CodeHTTPRetryMeaningWhat to do
forbidden403NoThe 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.

CodeHTTPRetryMeaningWhat to do
rate_limited429Yes, laterThe 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.summary