Get notification preferences

Retrieve notification preferences for your workspace

GET/api/v2/notifications/preferences

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Preferences retrieved successfully

successboolean

dataNotificationPreferences

Show properties

emailEnabledbooleanrequired

default: true

webhookEnabledbooleanrequired

default: false

inAppEnabledbooleanrequired

default: true

slackEnabledbooleanrequired

discordEnabledbooleanrequired

emailRecipientsstring<email>[]required

webhookUrlstring<uri> | nullrequired

hasWebhookSecretbooleanrequired

Whether a signing secret is stored. The value itself is never returned.

quotaAlertThresholdsinteger[]required

enabledTypesstring[]required

createdAtstring<date-time>required

updatedAtstring<date-time>required

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.

Request

curl -X GET 'https://api.anlyon.com/api/v2/notifications/preferences' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/notifications/preferences", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/notifications/preferences",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "emailEnabled": true,
    "webhookEnabled": false,
    "inAppEnabled": true,
    "slackEnabled": true,
    "discordEnabled": true,
    "emailRecipients": [
      "user@example.com"
    ],
    "webhookUrl": "http://example.com",
    "hasWebhookSecret": true,
    "quotaAlertThresholds": [
      50,
      75,
      90,
      100
    ],
    "enabledTypes": [
      "quota_warning"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}