API referenceGET

Get alert settings

Read the email alert settings for new relevant mentions, including the cadences the current plan allows.

GEThttps://ai.redreplier.com/ai-app/api/v1/alert-settings

Read the email alert settings for new relevant mentions, including the cadences the current plan allows.

Bearer Token (RedReplier API token)

Parameters

This endpoint does not take path or query parameters.

Request body

This endpoint does not require a JSON body.

Response

Returns alert settings for the token account.

  • enabled (boolean): Whether email alerts are enabled.
  • cadenceMinutes (number): Configured alert cadence in minutes.
  • minIntervalMinutes (number): Fastest cadence allowed by the current plan.
  • availableCadences (number[]): Cadence values available to the current plan.

Notes

minIntervalMinutes is the fastest cadence allowed by the current plan.

Errors

  • 400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
  • 401 Unauthorized: Missing or invalid Bearer token, or code: "token_issuer_lost_access" when the person who created the API key was deactivated or left the workspace.
  • 403 Forbidden: code: "subscription_required" when the workspace plan does not include API access, code: "workspace_access_denied" when X-Workspace-Id names a workspace this credential cannot reach, or code: "permission_denied" when your role in the workspace does not hold redreplier.write (Admin and Editor hold it).
  • 404 Not Found: The resource does not exist for the token account.
  • 429 Too Many Requests: Rate limit exceeded. Wait the seconds in Retry-After.
  • 500 Internal Server Error: Unexpected server error.
Example request (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/alert-settings \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "enabled": true,
  "cadenceMinutes": 240,
  "minIntervalMinutes": 60,
  "availableCadences": [60, 120, 180, 240, 720, 1440]
}