> ## Documentation Index > Fetch the complete documentation index at: https://docs.lobbystack.com/llms.txt > Use this file to discover all available pages before exploring further. # Get alert settings > The alerts the account the key acts as gets about this business, by email and by text. A platform key acts as its owner_email account, which has to be on the business's team, or it's a 409. ## OpenAPI ````yaml /api-reference/openapi.json get /notification-preferences openapi: 3.1.0 info: title: LobbyStack API version: v1 description: >- Read calls, contacts, appointments and messages, book appointments, and subscribe to webhooks. Authenticate with an API key in the Authorization header. A platform key also names the business it acts on in the LobbyStack-Business header. Each key allows 120 requests per minute by default. servers: - url: https://app.lobbystack.com/api/v1 security: - bearerAuth: [] tags: - name: Business - name: Receptionist - name: Billing - name: Phone numbers - name: Onboarding - name: Team - name: Website chat - name: Calendars - name: Notifications - name: Calls - name: Contacts - name: Appointments - name: Messages - name: Knowledge - name: Webhooks - name: Platform paths: /notification-preferences: get: tags: - Notifications summary: Get alert settings description: >- The alerts the account the key acts as gets about this business, by email and by text. A platform key acts as its owner_email account, which has to be on the business's team, or it's a 409. operationId: getNotificationPreferences parameters: - name: LobbyStack-Business in: header description: >- The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business. schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/NotificationPreferences' '400': description: >- The request is invalid (invalid_request), or a platform key sent no LobbyStack-Business header (business_required). content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The API key is missing, invalid, or revoked (unauthorized). content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Refused. insufficient_scope: the key lacks the business:read scope. forbidden: a per-business key named another business in LobbyStack-Business. key_owner_inactive: the person the key acts for can't any more: a per-business key's creator is no longer an owner or admin, or a platform key's owner_email has no verified LobbyStack account. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: A platform key named a business it cannot act on (not_found). content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Too many requests (rate_limited). Wait for the Retry-After header's number of seconds. content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: integer description: Seconds to wait. security: - bearerAuth: [] components: schemas: NotificationPreferences: type: object properties: email_enabled: type: boolean description: 'false: no alert emails at all, whatever events says.' sms_enabled: type: boolean description: 'false: no alert texts at all, whatever events says.' events: type: object properties: voice_message: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: A caller left a message during a call. text_message: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: A customer texted the business number. customer_sms_failed: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: >- A confirmation or reminder text to a customer failed or wasn't delivered. calendar_sync: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: An appointment couldn't sync to the connected calendar. transfer_failed: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: >- The receptionist tried to transfer a caller to a person, and the transfer didn't complete. website_chat: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: >- A visitor wrote through the website chat widget. At most one alert per chat a day. webhook_disabled: type: object properties: email: type: boolean sms: type: boolean required: - email - sms additionalProperties: false description: >- LobbyStack stopped sending events to a webhook endpoint after its deliveries failed for about a day. required: - voice_message - text_message - customer_sms_failed - calendar_sync - transfer_failed - website_chat - webhook_disabled additionalProperties: false description: Which alerts go out by email and which by text. daily_summary: type: object properties: enabled: type: boolean send_time: anyOf: - type: string pattern: ^(?:[01]\d|2[0-3]):[0-5]\d$ description: Local time in the business's time zone, as 24-hour HH:MM. - type: 'null' description: When the summary of the day before goes out. required: - enabled - send_time additionalProperties: false description: A daily summary of the alerts. sms: type: object properties: available: type: boolean description: true when texts can be turned on. unavailable_reason: anyOf: - type: string enum: - sender_missing - phone_unverified - consent_required - type: 'null' description: >- sender_missing: the deployment has no number to send alerts from. phone_unverified: the account has no verified mobile number. consent_required: the account hasn't agreed to alert texts. The account's owner fixes the last two in the dashboard's notification settings. required: - available - unavailable_reason additionalProperties: false required: - email_enabled - sms_enabled - events - daily_summary - sms additionalProperties: false description: >- The alerts the account the key acts as gets about this business. Each person on the team has their own. Error: type: object properties: error: type: object properties: code: type: string enum: - invalid_request - unauthorized - forbidden - insufficient_scope - not_found - conflict - idempotency_key_reused - idempotency_request_in_progress - booking_disabled - booking_requires_confirmation - slot_unavailable - rate_limited - rate_limit_unavailable - method_not_allowed - internal_error - business_required - key_owner_inactive - plan_limit_reached message: type: string details: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false required: - code - message additionalProperties: false required: - error additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.