Get the caller's own notification preferences

GET

/v1/settings/notifications

curl --request GET \
  --url https://dev-api.infiniteaudience.ai/v1/settings/notifications \
  --header 'Authorization: Bearer <token>'

• Development API Server

Returns the caller’s per-event-type email notification preferences — the user-scoped equivalent of the org-scoped webhook config, covering the same four event types. Unset keys default to false (opt-out) — no email is sent for any event type until the user explicitly opts in. Requires ‘account’ scope.

Authorizations

• bearerAuth

Responses

200

Current notification preferences.

Media typeapplication/json

object

notification_preferences

required

object

segment.ready

required

boolean

segment.failed

required

boolean

delivery.completed

required

boolean

delivery.failed

required

boolean

Example^generated

{
  "notification_preferences": {
    "segment.ready": true,
    "segment.failed": true,
    "delivery.completed": true,
    "delivery.failed": true
  }
}

401

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

Media typeapplication/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

Examplemissing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}