Branch
List Branches
List all branches 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 branches.
sort?|
Sort column (e.g. created_at, name_en).
key_by?|
Key response by column.
includes*array<>
filter?object
filter.market_id?|
Filter by market ID. Must match an existing stored value.
filter.branches_ids*array<>
Must match an existing stored value.
filter.is_active?|
Filter by active status.
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/branches?page=1&per_page=20&search=Downtown&sort=created_at&key_by=id&includes=sapiente&filter.market_id=uuid&filter.branches_ids=sed&filter.is_active=true" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Branches retrieved successfully."
},
"data": {
"current_page": 1,
"current_page_url": "http://localhost:8000/api/v2/branches?page=1",
"data": [
{
"id": "7cc769cf-ed8f-4f3c-baa8-032a91fe8fa5",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"name_en": "Maggio, O'Connell and Gaylord",
"name_ar": "Maggio, O'Connell and Gaylord",
"address": "1673 Cleta Springs Suite 430\nCassinbury, NV 11880",
"latitude": 22.245179,
"longitude": -22.317667,
"is_active": true,
"created_at": 1787446686231,
"updated_at": 1787446686231,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"code": "BR-316036"
},
{
"id": "1d5f5413-4b50-4430-8b37-1d2711a6945f",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"name_en": "Lemke, Kilback and Mraz",
"name_ar": "Lemke, Kilback and Mraz",
"address": "6219 Jade Branch Apt. 229\nKaleytown, NM 32983",
"latitude": 46.26176,
"longitude": 83.469062,
"is_active": true,
"created_at": 1787446686231,
"updated_at": 1787446686231,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"code": "BR-947847"
},
{
"id": "eae340e8-9465-4f47-a628-e39dcafc9b82",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"name_en": "Kilback Ltd",
"name_ar": "Kilback Ltd",
"address": "225 Evelyn Groves\nLindberg, VA 36666",
"latitude": 82.740279,
"longitude": 39.163517,
"is_active": true,
"created_at": 1787446686231,
"updated_at": 1787446686231,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"code": "BR-591808"
},
{
"id": "713790b2-fb0b-47fb-8dd2-639e45484dd9",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"name_en": "Quitzon, Dickinson and Bode",
"name_ar": "Quitzon, Dickinson and Bode",
"address": "18860 Vandervort Stream Apt. 437\nSouth Alisontown, OR 61289",
"latitude": 24.080724,
"longitude": 3.239177,
"is_active": true,
"created_at": 1787446674762,
"updated_at": 1787446674762,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"code": "BR-855731"
},
{
"id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"name_en": "Pacocha LLC",
"name_ar": "Pacocha LLC",
"address": "505 Brandi Corners Apt. 877\nLake Emieside, AL 44416-6003",
"latitude": 58.790845,
"longitude": -157.481388,
"is_active": true,
"created_at": 1787446674762,
"updated_at": 1787446674762,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"code": "BR-725617"
}
],
"first_page_url": "http://localhost:8000/api/v2/branches?page=1",
"from": 1,
"next_page_url": null,
"path": "http://localhost:8000/api/v2/branches",
"per_page": 20,
"prev_page_url": null,
"to": 5
}
}{
"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
}