Icon
List Icons
List the shared icon catalog for pickers across modules.
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 in the icon code.
sort?|
Sort field and direction (e.g., code, source, -code).
key_by?|
Key the results by this field.
filter?|
filter.source?|
Filter by icon source (e.g., tabler, lucide, feather, radix).
filter.category?|
Filter by icon category (see GET /v2/icons/categories).
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/icons?page=1&per_page=50&search=delivery&sort=code&key_by=code&filter.source=tabler&filter.category=E-commerce" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Icon list retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "d457f8f1-a52e-4336-b25c-cd8e5f0d51b1",
"source": "tabler",
"code": "shopping-bag",
"svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\"><path d=\"M6 8h12l-1 12H7z\"/></svg>",
"category": "E-commerce"
},
{
"id": "e46c74cf-d8a9-4d38-a827-a174930d3a0e",
"source": "tabler",
"code": "tools-kitchen-2",
"svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\"><path d=\"M8 3v7a2 2 0 0 0 4 0V3\"/></svg>",
"category": "Food"
},
{
"id": "8254803d-1404-4a64-8dfb-01fbda0c487e",
"source": "tabler",
"code": "truck-delivery",
"svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\"><path d=\"M3 6h11v9H3z\"/></svg>",
"category": "E-commerce"
}
],
"first_page_url": "http://localhost:8000/api/v2/icons?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/icons?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/icons?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/icons",
"per_page": 50,
"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
}