List

Developing

DEVELOPMENT

GET

https://api.flavours.sa/dev/api/v2/branches

Request Body

Validation

Field	Type	Rule	Description
`page`	`integer`	`nullable`	Read more on the `Pagination` page
`per_page`	`integer`	`nullable`	Read more on the `Pagination` page
`search`	`string`	`nullable`
`sort`	`string`	`nullable`	Read more on the `Sorting` page
`includes`	`array`	`nullable`	Read more on the `Includables` page
`filter.market_id`	`string`	`nullable`	Id from `Market` model
`filter.is_active`	`boolean`	`nullable`

Field filter.market_id required for user with SUBSCRIBER role

Request

Authorization

Add parameter in header

API-TOKEN

Example:

API-TOKEN: ********************

Query Params

page

integer

optional

Nullable

Example:

per_page

integer

optional

Nullable | Default : 20

Example:

string

optional

Nullable

sort

string

optional

Nullable

includes

array[string]

optional

Nullable | From "/api/constant/branch-include"

filter[market_id]

string

optional

Nullable | Required if user role SUBSCRIBER

Example:

b5d70a92-5d2e-4f89-8e52-1827cfbd01f4

filter[is_active]

integer

optional

Nullable | Boolean

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://api.flavours.sa/dev/api/v2/branches?page=1&per_page=20&search=&sort=&includes=&filter[market_id]=b5d70a92-5d2e-4f89-8e52-1827cfbd01f4&filter[is_active]=1' \
--header 'API-TOKEN;'

Responses

🟠403Forbidden

application/json

Body

List

Request Body#

Validation#

Request

Request samples

Responses

Request Body

Validation