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

# List Banners by Engine

> Returns all banners configured for the given search engine.



## OpenAPI

````yaml /openapi/search-tools.json get /api/banners/site/{engineId}
openapi: 3.1.0
info:
  title: Cludo Search Tools API
  version: 4.0.0
  description: >-
    Manage search experience tools: banners, rankings, quicklinks, and synonym
    groups for Cludo search engines.
servers:
  - url: https://api.cludo.com
    description: EU region (Customer IDs below 10,000,000)
  - url: https://api-us1.cludo.com
    description: US region (Customer IDs 10,000,000 and above)
security:
  - BasicAuth: []
paths:
  /api/banners/site/{engineId}:
    get:
      summary: List Banners by Engine
      description: Returns all banners configured for the given search engine.
      operationId: listBanners
      parameters:
        - $ref: '#/components/parameters/engineId'
      responses:
        '200':
          description: List of banners for the engine.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Banner'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BasicAuth: []
components:
  parameters:
    engineId:
      name: engineId
      in: path
      required: true
      description: Search engine whose banners, rankings, or quicklinks you are managing.
      schema:
        type: integer
  schemas:
    Banner:
      type: object
      required:
        - name
        - htmlcode
        - websiteid
      properties:
        id:
          type: integer
          description: Banner ID (assigned by server on create).
        name:
          type: string
          description: Internal label in MyCludo (not shown to end users).
        htmlcode:
          type: string
          description: >-
            HTML snippet injected on the SERP when terms match (keep accessible
            and scoped).
        bannerterms:
          type: array
          items:
            $ref: '#/components/schemas/BannerTerm'
          description: >-
            List of trigger phrases; any match can activate the banner depending
            on engine rules.
        websiteid:
          type: integer
          description: Search engine ID.
        isDisabled:
          type: boolean
          description: When true, the banner is stored but never served.
        from:
          type:
            - string
            - 'null'
          format: date-time
          description: Start of scheduled display window.
        to:
          type:
            - string
            - 'null'
          format: date-time
          description: End of scheduled display window.
        audiences:
          type:
            - array
            - 'null'
          items: true
          description: >-
            Audience targeting configuration. Omit the field entirely (or send
            `null`) when the banner is not audience-targeted.
        engineIds:
          type:
            - array
            - 'null'
          items:
            type: integer
          description: Managed by the Cludo backend; informational only.
        frequency:
          type:
            - string
            - 'null'
          description: Managed by the Cludo backend; informational only.
        daysOfWeek:
          type:
            - string
            - 'null'
          description: Managed by the Cludo backend; informational only.
        cssCode:
          type:
            - string
            - 'null'
          description: Managed by the Cludo backend; informational only.
        jsonOption:
          type:
            - string
            - 'null'
          description: Managed by the Cludo backend; informational only.
        editorType:
          type:
            - string
            - 'null'
          description: Managed by the Cludo backend; informational only.
        brokenLinksFoundAt:
          type:
            - string
            - 'null'
          description: Timestamp when broken links were last detected, if any.
    BannerTerm:
      type: object
      required:
        - name
      additionalProperties: false
      properties:
        name:
          type: string
          description: >-
            Search term or phrase that triggers this banner when the user’s
            query matches.
    UnauthorizedError:
      type: object
      description: Returned when authentication fails.
      properties:
        message:
          type: string
          description: Authentication failure reason.
    ServerError:
      type: object
      description: Returned when an unexpected server error occurs.
      properties:
        status:
          type: string
          description: HTTP status name.
        code:
          type: integer
          description: HTTP status code.
        messages:
          type: array
          items:
            type: string
          description: Error details, usually including a support reference id.
  responses:
    Unauthorized:
      description: >-
        Authentication failed. The Authorization header is missing or contains
        invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
          example:
            message: unauthorized
    InternalServerError:
      description: >-
        An unexpected server error occurred. If this persists, contact
        support@cludo.com.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerError'
          example:
            status: InternalServerError
            code: 500
            messages:
              - >-
                Error occur. Please contact support with error ID:
                a1b2c3d4-e5f6-7890-abcd-ef1234567890
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication. Use your Customer ID as the username and API Key
        as the password. Example header: `Authorization: Basic
        MTIzNDU2NzpteS1hcGkta2V5`.

````