> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Get my notification preferences > Returns the authenticated admin’s category/event switches and optional signed credentials for both the shared workspace feed and personal feed. Credentials are null when subscriber HMAC is unavailable. The response is private and must not be cached. Category/event/channel keys come from this catalog. Requires permission: notification_preferences_self_service. ## OpenAPI ````yaml get /admin/notification-preferences openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /admin/notification-preferences: get: tags: - Notifications summary: Get my notification preferences description: >- Returns the authenticated admin’s category/event switches and optional signed credentials for both the shared workspace feed and personal feed. Credentials are null when subscriber HMAC is unavailable. The response is private and must not be cached. Category/event/channel keys come from this catalog. Requires permission: notification_preferences_self_service. operationId: workspace_Admin_NotificationPreferenceController_index responses: '200': description: Operation result. content: application/json: schema: properties: audience: type: string example: admin novu_subscriber: properties: subscriber_id: description: >- Authenticated workspace or personal subscriber identifier. type: string example: client_12_user_42 subscriber_hash: description: Subscriber-scoped HMAC credential. type: string example: example-hmac-value type: object nullable: true novu_user_subscriber: properties: subscriber_id: description: >- Authenticated workspace or personal subscriber identifier. type: string example: client_12_user_42 subscriber_hash: description: Subscriber-scoped HMAC credential. type: string example: example-hmac-value type: object nullable: true catalog: $ref: '#/components/schemas/NotificationPreferenceCatalog' type: object '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The authenticated user lacks access to this workflow or its related records. security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v1 description: Gratona V1 API components: schemas: NotificationPreferenceCatalog: type: array items: properties: key: type: string example: collaboration label: type: string example: Team collaboration description: type: string example: Direct mentions in comments on records you can access. criticality: type: string example: standard requires_disable_warning: type: boolean example: false channels: type: array items: description: >- Delivery channel. in_app and browser are accepted aliases for push. type: string enum: - email - push - in_app - browser example: email enabled: type: object additionalProperties: type: boolean mappings: properties: novu_templates: type: array items: type: string activity_actions: type: array items: type: string type: object events: type: array items: properties: key: type: string example: mentioned label: type: string example: Someone mentions you channels: type: array items: description: >- Delivery channel. in_app and browser are accepted aliases for push. type: string enum: - email - push - in_app - browser example: email enabled: type: object additionalProperties: type: boolean novu_workflow: type: string example: collaboration-mention nullable: true mappings: properties: email_triggers: type: array items: type: string novu_event_types: type: array items: type: string novu_templates: type: array items: type: string activity_actions: type: array items: type: string type: object type: object type: object UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.