Recipe
List Recipes
List all recipes 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 by recipe name.
sort?|
Sort field and direction (e.g., name, -created_at).
key_by?|
Key the results by this field.
includes*array<>
filter?object
filter.market_id?|
The id of an existing record in the markets table.
filter.branch_id?|
The id of an existing record in the branches table.
filter.recipes_ids?array<>
The id of an existing record in the recipes table.
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/recipes?page=1&per_page=20&search=sauce&sort=-created_at&key_by=id&includes=voluptates&filter.market_id=eius&filter.branch_id=minus&filter.recipes_ids=laboriosam" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Recipe list retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "9c1d6b7e-3f2a-4c5b-9e8d-1a2b3c4d5e6f",
"market_id": "6f88aed5-6f6d-4394-a120-6dc470736b31",
"branch_id": "df1f36b7-1587-4746-a450-7e0487475df4",
"name": "Tomato Sauce",
"created_at": 1770542643118,
"updated_at": 1770542643118
}
],
"first_page_url": "https://flavourspos.test/api/v2/recipes?page=1",
"from": 1,
"next_page_url": null,
"path": "https://flavourspos.test/api/v2/recipes",
"per_page": 20,
"prev_page_url": null,
"to": 1
}
}{
"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
}