# Return Active Banners

This API endpoint will return max 5 banners as that is the enabled banners count.

Endpoint: GET /v1/banners/active
Version: 1.0
Security: x-api-key

## Header parameters:

  - `Harness-Account` (string)
    Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

## Query parameters:

  - `search_term` (string)
    This would be used to filter resources having attributes matching with search term.

  - `page` (integer)
    Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page

  - `limit` (integer)
    Number of items to return per page.

  - `sort` (string)
    Parameter on the basis of which sorting is done.
    Enum: "name", "identifier", "created", "updated"

  - `order` (string)
    Order on the basis of which sorting is done.
    Enum: "ASC", "DESC"

## Response 200 fields (application/json):

  - `banner` (object, required)
    This is the request dto to create a Banner in Harness

  - `banner.name` (string, required)

  - `banner.identifier` (string, required)

  - `banner.enabled` (boolean)

  - `banner.intent` (string, required)
    enum for "intent" field in BannerDTO
    Enum: "INFORMATIONAL", "HIGH", "MEDIUM", "LOW"

  - `banner.title` (string, required)
    Banner Title with max length 80

  - `banner.message` (string, required)
    Banner Message with max length 250

  - `banner.callToActions` (object)

  - `created` (integer)

  - `updated` (integer)