Carousel
List Carousels
List all carousels 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 carousels.
sort?|
Sort column (e.g. created_at, market_id).
key_by?|
Key response by column.
includes*array<>
filter?object
filter.market_id?|
Filter by market ID. Must match an existing stored value.
filter.branch_id?|
Filter by branch ID. Must match an existing stored value.
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/carousels?page=1&per_page=20&search=summer&sort=created_at&key_by=id&includes=qui&filter.market_id=uuid&filter.branch_id=uuid" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Carousels retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "e018e8db-3845-449f-b839-9cf89b0788d7",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"title": "Repudiandae id odit quia.",
"image_url": "https://via.placeholder.com/640x480.png/00dd00?text=business+carousel+est",
"order": 1,
"created_at": 1787446692443,
"updated_at": 1787446692443
},
{
"id": "62b4fb58-87e1-4265-a4ef-9e505b35ad4e",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"title": "Voluptatibus et hic minus.",
"image_url": "https://via.placeholder.com/640x480.png/00eeff?text=business+carousel+voluptatibus",
"order": 2,
"created_at": 1787446692443,
"updated_at": 1787446692443
},
{
"id": "b388aff2-6e1a-4595-97bf-fd67cecaeb9a",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"title": "Fuga sed quibusdam excepturi.",
"image_url": "https://via.placeholder.com/640x480.png/0088bb?text=business+carousel+voluptas",
"order": 3,
"created_at": 1787446692443,
"updated_at": 1787446692443
}
],
"first_page_url": "http://localhost:8000/api/v2/carousels?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/carousels?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/carousels?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/carousels",
"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
}