Banner
List Banners
List all banners with pagination and filtering options.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Query Parameters
page?|
Page number for pagination. Must be at least 1.
per_page?|
Number of items per page. Must be at least 1.
search?|
Search term for filtering.
sort?|
Sort column (e.g. created_at).
key_by?|
Key response by column.
includes*array<>
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.flavours.sa/dev/api/v2/banners?page=1&per_page=20&search=Summer+Sale&sort=created_at&key_by=id&includes=ad" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"current_page": 1,
"data": [
{
"id": "d97a63a7-bded-4266-ab3e-ed7041d15afd",
"title_en": "Minus cum rerum qui.",
"title_ar": "Et aspernatur omnis.",
"description_en": "Deleniti quia qui hic et voluptatem minus quia. Dolor et aliquid qui architecto optio iure. Consequuntur inventore placeat dolor est illum est aut. Quibusdam maiores tempora velit itaque autem.",
"description_ar": "Adipisci vel at vel id placeat. Modi perferendis incidunt similique. Debitis natus harum eveniet ex non reiciendis.",
"cover_img": "https://via.placeholder.com/640x480.png/006622?text=nisi",
"button_url": "http://www.denesik.com/",
"button_label_en": "Learn More",
"button_label_ar": "اعرف المزيد",
"created_at": 1787446682424,
"updated_at": 1787446682424
},
{
"id": "a55d9cdf-ae21-45bb-81fb-dd0d295ec1bd",
"title_en": "Voluptatem consequatur quibusdam adipisci.",
"title_ar": "Facilis temporibus temporibus quasi.",
"description_en": "Sit architecto qui quo. Asperiores deleniti numquam ullam sed laborum rem omnis aperiam. Ad suscipit doloremque soluta aliquam.",
"description_ar": "Nihil et sint exercitationem adipisci magnam et. Corrupti quia autem est adipisci voluptas. Illo voluptas quas est quae laborum et amet. Hic dolor ut unde maxime excepturi in dignissimos.",
"cover_img": "https://via.placeholder.com/640x480.png/00eeff?text=iure",
"button_url": "https://www.spinka.info/reiciendis-optio-excepturi-quo-eum-nihil",
"button_label_en": "Learn More",
"button_label_ar": "اعرف المزيد",
"created_at": 1787446682424,
"updated_at": 1787446682424
},
{
"id": "2ed0d432-2f0e-434d-81ed-e23c5f16a0e0",
"title_en": "Nihil sit incidunt sint nihil.",
"title_ar": "Minus reiciendis illum unde.",
"description_en": "Aut delectus doloribus aut esse necessitatibus. Ut blanditiis placeat cum corrupti quis rem dolor. Delectus eius dolorem maxime veritatis non est.",
"description_ar": "Pariatur molestias minima in neque. In animi aut aspernatur voluptate numquam ullam et voluptatem.",
"cover_img": "https://via.placeholder.com/640x480.png/003355?text=vel",
"button_url": "http://www.hamill.com/",
"button_label_en": "Learn More",
"button_label_ar": "اعرف المزيد",
"created_at": 1787446682424,
"updated_at": 1787446682424
}
],
"first_page_url": "http://localhost:8000/api/v2/banners?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/banners?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/banners?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/v2/banners",
"per_page": 20,
"prev_page_url": null,
"to": 3,
"total": 3
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}