List banners

GET

/api/v1/banners

Retrieve a paginated list of banners for mobile display.
Results can be filtered by position and status.
Results are ordered by sort_order ascending by default.
Authentication Required

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Successful response

Bodyapplication/json

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/banners?position=undefined&status=undefined&search=undefined&page=undefined&per_page=undefined&sort_by=undefined&sort_order=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "banners": [
            {
                "id": 1,
                "title": "New Year Promotion",
                "description": "Get 20% off on all services",
                "url": "https://example.com/promo",
                "position": "home",
                "status": "draft",
                "image_url": "https://example.com/rails/active_storage/blobs/banner.jpg",
                "sort_order": 1,
                "start_date": "2025-01-01T00:00:00Z",
                "end_date": "2025-12-31T23:59:59Z"
            }
        ]
    },
    "meta": {
        "page": 1,
        "per_page": 20,
        "total_count": 100,
        "total_pages": 5,
        "prev_page": null,
        "next_page": 2
    }
}

Modified at 2026-06-08 00:59:16

Validate a promotion code

Get banner details