Advertisement
List Advertisements
List all advertisements 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 advertisements.
sort?|
Sort column (e.g. created_at, type).
key_by?|
Key response by column.
includes*array<>
filter?object
filter.market_id?|
Filter by market ID. Must match an existing stored value.
filter.types*array<>
filter.statuses*array<>
filter.start_at?|
Filter by start timestamp. Must be 13 digits.
filter.close_at?|
Filter by close timestamp. Must be 13 digits.
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/advertisements?page=1&per_page=20&search=promotion&sort=created_at&key_by=id&includes=earum&filter.market_id=uuid&filter.types=SMS&filter.statuses=SUCCESS&filter.start_at=1704067200000&filter.close_at=1704153600000" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"current_page": 1,
"data": [
{
"id": "868a7ab0-e7af-49ed-a7c9-202ae75ed624",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"type": "BANNER",
"status": "ACCEPTED",
"content": "https://via.placeholder.com/640x480.png/006600?text=quia",
"notes": "Illo repellat quia laborum eveniet eveniet ducimus.",
"approved_by": "d34ef5d2-fd91-4719-a0c3-53c1d9faa285",
"start_at": 1787446676174,
"close_at": 1787533076174,
"created_at": 1787446674747,
"updated_at": 1787446674747
},
{
"id": "1e2d7e32-10e6-4b3d-934b-99c9c8834988",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"type": "BANNER",
"status": "REJECTED",
"content": "https://via.placeholder.com/640x480.png/0022cc?text=ut",
"notes": "Sunt unde occaecati magnam eius enim.",
"approved_by": "815c48b0-b760-4ed8-94fd-94b33409179f",
"start_at": 1787446676175,
"close_at": 1787533076175,
"created_at": 1787446674747,
"updated_at": 1787446674747
},
{
"id": "1248c00e-58d2-4c66-95f0-a4e2d244ea32",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"type": "BANNER",
"status": "PROCESS",
"content": "https://via.placeholder.com/640x480.png/0022aa?text=in",
"notes": "Magnam recusandae voluptatem illum animi qui.",
"approved_by": "e479e18b-0ddc-4d1c-b052-d37174127f8e",
"start_at": 1787446676172,
"close_at": 1787533076172,
"created_at": 1787446674747,
"updated_at": 1787446674747
}
],
"first_page_url": "http://localhost:8000/api/v2/advertisements?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/advertisements?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/advertisements?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/advertisements",
"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
}