Client Settings

Get notification settings

Retrieves the saved notification settings for the authenticated client.

This endpoint is available only to client API keys. The master API key cannot use client self-service settings.

The response contains the saved notification email and whether automatic email notifications are enabled.

get/client/notifications

Request

Base URL
http://127.0.0.1:5000/api/v1
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/clinicalauditai/apis/clinicalauditai-api/docs/client/notifications/get.ts
A function with typed inputs. Its response is checked against the schema.

Notification settings retrieved successfully

notification_emailstring email nullable required

Saved email address used for client notifications.

notify_emailboolean required

Whether saved email notifications are enabled.

No recorded changes to this operation across all 1 revision of this API.