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.
Test mode: A test key sees the account's preferences (one set, for live and test).
Example
curl 'https://staging.socialtap.dev/v1/notification_preferences' \
-H "x-api-key: $SOCIALTAP_API_KEY"Response
200
Get notification preferences
| Field | Type | Description |
|---|---|---|
data | object | |
data.categories | object[] | Every notification category, in display order. Security email is in none: it is always sent. |
data.categories[].category | string | The notification category. One of credits, spend_limits, jobs, api_keys, webhooks |
data.categories[].email | boolean or null | Whether the owner is emailed (default on); null when the category sends no email. |
data.categories[].in_app | boolean | Whether the dashboard shows it (default on). Webhooks always get every event. |
data.object | string | Always notification_preferences. One of notification_preferences |
meta | object | The shared route meta (see the API reference introduction). |
dataobjectShowHide 2 child fields
categoriesobject[]Every notification category, in display order. Security email is in none: it is always sent.
ShowHide 3 child fields
categorystringThe notification category.
One ofcreditsspend_limitsjobsapi_keyswebhooks
emailbooleannullableWhether the owner is emailed (default on); null when the category sends no email.
in_appbooleanWhether the dashboard shows it (default on). Webhooks always get every event.
objectstringAlways notification_preferences.
One ofnotification_preferences
metaobjectThe shared route meta (see the API reference introduction).
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_inputNo retryThe 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.
| 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 retryThe 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 retryThe 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, 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).
A test key sees the account's preferences (one set, for live and test).
operationId notification_preferences.get