Notifications

Get notification preferences

GET /v1/notification_preferences

Per category: email and dashboard on or off (default on). Security mail is always sent. Free.

Auth: an API key with the account:read scope, or the dashboard session.

Example

cURL
curl 'https://socialtap.dev/v1/notification_preferences' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
x-api-keystringheaderrequired

Your API key, with the account:read scope. Authentication

Response

application/json

200

Get notification preferences

dataobject
ShowHide 2 child fields
categoriesobject[]

Every notification category, in display order. Security email is in none: it is always sent.

ShowHide 3 child fields
categorystring

The notification category.

One ofcreditsspend_limitsjobsapi_keyswebhooks

emailbooleannullable

Whether the owner is emailed (default on); null when the category sends no email.

in_appboolean

Whether the dashboard shows it (default on). Webhooks always get every event.

objectstring

Always notification_preferences.

One ofnotification_preferences

metaobject

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

400

400 Bad Request.

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too 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, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId notification_preferences.get