Flavours API
Banner

List Banners

GET
/api/v2/banners

List all banners with pagination and filtering options.

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 "http://localhost:8000/api/v2/banners?page=1&per_page=20&search=Summer+Sale&sort=created_at&key_by=id&includes=saepe" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": "bf19a6ac-b774-427a-b5ad-95a86db99c5c",
        "title_en": "In et est nesciunt veniam.",
        "title_ar": "Quidem quasi recusandae aperiam.",
        "description_en": "Sapiente ut repellendus pariatur pariatur ipsa aperiam. Quibusdam tempore ab necessitatibus quidem aliquid consequuntur. Nisi sunt facere sunt quod. Ut dolorem id qui facilis qui vero.",
        "description_ar": "Facilis aliquam ullam minus est voluptatem maxime. Praesentium ut aut sed architecto eveniet vel. Reiciendis neque asperiores velit sed et.",
        "cover_img": "https://via.placeholder.com/640x480.png/004422?text=sit",
        "button_url": "http://www.hegmann.com/",
        "button_label_en": "Learn More",
        "button_label_ar": "اعرف المزيد",
        "created_at": 1782824832797,
        "updated_at": 1782824832797
      },
      {
        "id": "ba9fd444-2c9f-440c-b017-b12e4733ad86",
        "title_en": "Eveniet harum commodi.",
        "title_ar": "Tempora numquam minus illum.",
        "description_en": "Amet ut quia iure voluptates. Aliquid mollitia qui dolor commodi. Consequatur placeat consequuntur hic libero voluptatem laboriosam harum hic. Est officiis laborum ut exercitationem.",
        "description_ar": "Optio vel molestiae est aut assumenda ex explicabo. Ut libero dolor beatae. Voluptatem rerum sit consequatur. Saepe accusantium ratione explicabo molestiae nihil id ratione id.",
        "cover_img": "https://via.placeholder.com/640x480.png/000088?text=quod",
        "button_url": "http://donnelly.info/itaque-consectetur-ipsum-aut-commodi-saepe-nihil-non-recusandae",
        "button_label_en": "Learn More",
        "button_label_ar": "اعرف المزيد",
        "created_at": 1782824832797,
        "updated_at": 1782824832797
      },
      {
        "id": "9dbcaf68-250d-40c2-8cb1-b3354192ddaa",
        "title_en": "Quis sunt voluptatem.",
        "title_ar": "Temporibus voluptatum non excepturi.",
        "description_en": "Vel mollitia impedit numquam minus et. Eveniet cumque sunt quibusdam voluptatem. Ut soluta dolorem voluptatem nemo.",
        "description_ar": "Temporibus exercitationem dolores sunt deleniti necessitatibus corporis voluptate sit. Officia quis necessitatibus qui aliquam. Rerum vel repellat dolorem totam et fugiat. Quos expedita dolorem rem quidem perferendis mollitia et.",
        "cover_img": "https://via.placeholder.com/640x480.png/001144?text=ea",
        "button_url": "http://www.baumbach.com/nihil-et-sit-rerum-tempora-maiores-dolorem",
        "button_label_en": "Learn More",
        "button_label_ar": "اعرف المزيد",
        "created_at": 1782824832797,
        "updated_at": 1782824832797
      }
    ],
    "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": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "http://localhost:8000/api/v2/banners?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "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
}