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

# List active banners

> Returns all currently active, system-wide banners ordered by priority. Public endpoint — no authentication required.



## OpenAPI

````yaml /openapi/shared.yaml get /api/v1/banners/active
openapi: 3.0.3
info:
  title: Shared Service API
  version: 1.0.0
  description: |2-

        **Shared Service API** - Comprehensive shared service and management system.

        ## Versionings
        The API uses URL path versioning (e.g., `/api/v1/`, `/api/v2/`).
        Current version: **v1**
        
  contact:
    name: API Support
    email: thakacreations@gmail.com
  license:
    name: thakacreations
servers: []
security: []
paths:
  /api/v1/banners/active:
    get:
      tags:
        - banners
      summary: List active banners
      description: >-
        Returns all currently active, system-wide banners ordered by priority.
        Public endpoint — no authentication required.
      operationId: banners_active_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveBannerListResponse'
          description: ''
      security:
        - bearerAuth: []
        - {}
components:
  schemas:
    ActiveBannerListResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/ActiveBannerListData'
      required:
        - data
        - message
        - success
    ActiveBannerListData:
      type: object
      properties:
        banners:
          type: array
          items:
            $ref: '#/components/schemas/Banner'
      required:
        - banners
    Banner:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        title:
          type: string
          readOnly: true
        subtitle:
          type: string
          readOnly: true
        image_url:
          type: string
          readOnly: true
        entity_type:
          type: string
          readOnly: true
        entity_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        audience:
          enum:
            - all
            - registered
          type: string
          description: |-
            * `all` - All
            * `registered` - Registered
          x-spec-enum-id: 81fd8ae427aed981
          readOnly: true
        starts_at:
          type: string
          format: date-time
          readOnly: true
        ends_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        priority:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - audience
        - created_at
        - ends_at
        - entity_id
        - entity_type
        - id
        - image_url
        - priority
        - starts_at
        - subtitle
        - title
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Enter your JWT token in the format: Bearer <token>'

````