Banner feature
List Banner Features
List all banner features 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 by feature key.
sort?|
Sort column (e.g. created_at).
key_by?|
Key response by column.
includes?|
Include related data.
filter?object
filter.banner_id?|
Filter by banner ID. The id of an existing record in the banners table.
filter.roles*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 "http://localhost:8000/api/v2/banners/features?page=1&per_page=20&search=dashboard&sort=created_at&key_by=id&includes=feature&filter.banner_id=uuid&filter.roles=USER_MERCHANT" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"current_page": 1,
"data": [
{
"id": "dd0f2228-1943-4f59-83fd-0d48df2ea5f5",
"banner_id": "9534ffe1-ea22-4522-b50e-25203fdf2982",
"role": "USER_SUBSCRIBER",
"feature_key": "ACCOUNTING_RESUPPLY"
},
{
"id": "b44cccfe-dd95-4031-aef6-821924b19acc",
"banner_id": "d352b51d-fdad-4427-a76e-01db699bac31",
"role": "USER_SUBSCRIBER",
"feature_key": "ACCOUNTING_PURCHASE"
},
{
"id": "1a07427e-80a5-4915-bd64-ba614084c491",
"banner_id": "039c8063-e4b1-4920-9230-b35b0ac2f36a",
"role": "USER_SUBSCRIBER",
"feature_key": "ACCOUNTING_SUPPLIER"
}
],
"first_page_url": "http://localhost:8000/api/v2/banners/features?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/banners/features?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/banners/features?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/features",
"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
}