List notifications

Retrieve notifications for your workspace. For a caller with a user (a console session or an OAuth connection), types that user muted in their own preferences are left out of the list and the unread count.

GET/api/v2/notifications

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.

Query parameters

unreadOnlyboolean

Filter to only unread notifications

default: false

limitinteger

Number of notifications to return

min 1 · max 100 · default: 50

Header parameters

X-Request-Idstring

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

max length 128

Responses

200

Notifications retrieved successfully

successboolean

dataobject

Show properties

notificationsNotification[]

Show properties

Array of Notification

idstring<uuid>required

typestringrequired

Allowed:quota_warningquota_exceededpayment_failedplan_upgradedplan_downgradedfeature_enabledsystem_alertsecurity_alertdelivery_failure_spikeapi_key_expiringapproval_requestedbudget_alert

prioritystringrequired

Allowed:lowmediumhighcritical

titlestringrequired

messagestringrequired

metadataobject | nullrequired

actionUrlstring | nullrequired

actionLabelstring | nullrequired

isReadbooleanrequired

default: false

readAtstring<date-time> | nullrequired

createdAtstring<date-time>required

expiresAtstring<date-time> | nullrequired

unreadCountinteger

totalinteger

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

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

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

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.unreadOnlyqueryFilter to only unread notificationslimitqueryNumber of notifications to return

Request

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

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

import requests

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

Response

{
  "success": true,
  "data": {
    "notifications": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "quota_warning",
        "priority": "low",
        "title": "Quota Warning",
        "message": "You have used 75% of your daily message quota",
        "metadata": {},
        "actionUrl": "string",
        "actionLabel": "string",
        "isRead": false,
        "readAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "expiresAt": "2019-08-24T14:15:22Z"
      }
    ],
    "unreadCount": 3,
    "total": 10
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "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."
  }
}