> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sagescreen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the currently active splash banner

> Returns the single published splash banner, or `null` if there
is no active splash or the user has already seen it.

The check is based on the user meta `ss_last_splash_seen_id`.
Seeing the splash is tracked separately via `sagescreen_mark_splash_seen`.

Registered as `wp_ajax_sagescreen_get_active_splash` — **login required**.




## OpenAPI

````yaml /openapi/private/specs/wp/wp-ajax-misc.yml post /wp-admin/admin-ajax.php?action=sagescreen_get_active_splash
openapi: 3.1.0
info:
  title: SageScreen — Misc AJAX Modules (User · Council · Billing · Splash · Demo)
  version: 1.0.0
servers:
  - url: https://{domain}/wp-json/sagescreen/v1
    description: WordPress REST API
    variables:
      domain:
        default: api.sagescreen.app
security: []
tags:
  - name: User – REST
    description: Zapier-facing REST endpoints
  - name: User – AJAX
    description: Council user management AJAX endpoints
  - name: User – Profile
    description: Self-service profile updates
  - name: Council – REST
    description: Zapier-facing REST endpoints for council data sync
  - name: Council – AJAX
    description: Council user and sage management AJAX endpoints
  - name: Billing – Stripe
    description: Stripe webhook and subscription endpoints
  - name: Billing – Broadcast
    description: Postmark broadcast unsubscribe endpoint
  - name: Billing – Pipedrive
    description: Pipedrive CRM ID set-* webhook endpoints (called by Zapier)
  - name: Billing – AJAX
    description: Credit ledger, reactivation, and portal AJAX endpoints
  - name: Splash
    description: Splash banner AJAX endpoints
  - name: Demo
    description: Demo signup and management AJAX endpoints
  - name: CSV Upload
    description: Bulk candidate CSV upload
paths:
  /wp-admin/admin-ajax.php?action=sagescreen_get_active_splash:
    post:
      tags:
        - Splash
      summary: Get the currently active splash banner
      description: >
        Returns the single published splash banner, or `null` if there

        is no active splash or the user has already seen it.


        The check is based on the user meta `ss_last_splash_seen_id`.

        Seeing the splash is tracked separately via
        `sagescreen_mark_splash_seen`.


        Registered as `wp_ajax_sagescreen_get_active_splash` — **login
        required**.
      operationId: ajaxGetActiveSplash
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - action
                - nonce
              properties:
                action:
                  type: string
                  const: sagescreen_get_active_splash
                nonce:
                  type: string
                  description: WP nonce for `sagescreen_frontend_nonce`
      responses:
        '200':
          description: Splash banner (or null)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetActiveSplashResponse'
              examples:
                active:
                  summary: Active splash available
                  value:
                    success: true
                    data:
                      splash:
                        id: 42
                        title: 'New Feature: AI Voice'
                        subtitle: Now available in 35 languages
                        content: <p>We've added multi-language voice support.</p>
                        cta_text: Learn More
                        cta_link: /admin/home
                        image_url: >-
                          https://api.sagescreen.app/wp-content/uploads/splash-voice.jpg
                noSplash:
                  summary: No active splash or already seen
                  value:
                    success: true
                    data:
                      splash: null
      security:
        - wpAjaxNonce: []
components:
  schemas:
    GetActiveSplashResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
            - splash
          properties:
            splash:
              oneOf:
                - $ref: '#/components/schemas/SplashBanner'
                - type: 'null'
              description: The active splash or null if none / already seen
    SplashBanner:
      type: object
      description: Published splash banner
      properties:
        id:
          type: integer
          description: WordPress post ID
          examples:
            - 42
        title:
          type: string
          description: Banner headline (post_title)
          examples:
            - 'New Feature: AI Voice'
        subtitle:
          type: string
          description: Optional sub-heading (ss_subtitle meta)
          examples:
            - Now available in 35 languages
        content:
          type: string
          description: HTML body (ss_content meta, sanitized with wp_kses)
          examples:
            - <p>We've added multi-language voice support.</p>
        cta_text:
          type: string
          description: Call-to-action button label (ss_cta_text meta)
          examples:
            - Learn More
        cta_link:
          type: string
          description: |
            CTA destination. Special values:
            - `#` → close modal only
            - `/…` → internal link (same tab)
            - other → external link (new tab)
          examples:
            - /admin/home
        image_url:
          type: string
          description: Featured image URL (medium size) or empty string
          examples:
            - https://api.sagescreen.app/wp-content/uploads/splash-voice.jpg
  securitySchemes:
    wpAjaxNonce:
      type: apiKey
      in: query
      name: nonce
      description: WordPress AJAX nonce (passed as form field, verified per-action)

````