Flavours API Documentation
List

Developing
GET/users/customers
Validation

Field	Type	Rule	Description
`page`	`integer`	`nullable` `min:1`	Read more on the `Pagination` page
`per_page`	`integer`	`nullable` `min:1`	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
The rules on the fields will change depending on conditions, including the following
Field	Rule	Condition
`filter.market_id`	`required`	User authentication role `SUBSCRIBER`
Request

Authorization: Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
Query Params
page
integer
optional
Example:
per_page
integer
optional
Example:
string
optional
sort
string
optional
key_by
string
optional
includes
array[string]
optional
Example:
["userable"]
filter[market_id]
string
optional
Example:
b5d70a92-5d2e-4f89-8e52-1827cfbd01f4
Request samples

Responses

OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
meta
object
required
code
integer
required
status
string
required
message
string
required
data
object
required
current_page
integer
required
data
array [object {4}]
required
first_page_url
string
required
from
integer
required
last_page
integer
required
last_page_url
string
required
links
array [object {3}]
required
next_page_url
null
required
path
string
required
per_page
integer
required
prev_page_url
null
required
integer
required
total
integer
required
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": "fec2ff86-6196-4665-8bd9-4c2160b75b67",
        "created_by": null,
        "qoyod_id": null,
        "type": "ORGANIZATION",
        "tax_number": "11223344",
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": "11223344",
        "user": {
          "id": "0629fded-377d-4359-ab7a-185cd63667de",
          "userable_id": "fec2ff86-6196-4665-8bd9-4c2160b75b67",
          "role": "CUSTOMER",
          "name": "Test Organization",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "1122334455",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703755062385,
          "updated_at": 1703755062385,
          "deleted_at": null
        }
      },
      {
        "id": "f962f4f5-f35c-4245-8029-e117b7eda756",
        "created_by": null,
        "qoyod_id": null,
        "type": "ORGANIZATION",
        "tax_number": "1231231",
        "zip_code": "1231231",
        "city": "JKT",
        "district": "SAU",
        "street": "SEA",
        "crn": "2112121",
        "user": {
          "id": "0a27d38a-3845-4bf5-8c22-c13b24929f47",
          "userable_id": "f962f4f5-f35c-4245-8029-e117b7eda756",
          "role": "CUSTOMER",
          "name": "Tes oo",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "33445544231",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703840546590,
          "updated_at": 1703840546590,
          "deleted_at": null
        }
      },
      {
        "id": "f7becf4d-244a-4cc7-bbfa-16b1d4ac29f7",
        "created_by": null,
        "qoyod_id": null,
        "type": "INDIVIDUAL",
        "gender": "MALE",
        "user": {
          "id": "dcd91ec1-e115-4e9f-8746-0c2fc7fcaf97",
          "userable_id": "f7becf4d-244a-4cc7-bbfa-16b1d4ac29f7",
          "role": "CUSTOMER",
          "name": "aa",
          "username": null,
          "email": null,
          "phone_prefix": "973",
          "phone": "123456723",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703842468632,
          "updated_at": 1703842468632,
          "deleted_at": null
        }
      },
      {
        "id": "f7a876a9-5100-47cc-bd00-5d9739a07628",
        "created_by": null,
        "qoyod_id": "55",
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "3abe04e6-e92f-4230-a81f-a978c2af2b91",
          "userable_id": "f7a876a9-5100-47cc-bd00-5d9739a07628",
          "role": "CUSTOMER",
          "name": "New One",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "5123451234",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1682926946597,
          "updated_at": 1684063287839,
          "deleted_at": null
        }
      },
      {
        "id": "f7449b67-6b87-4786-9786-4fbc7889c453",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "b7dc6602-9987-4f3d-841e-fe743553ba6b",
          "userable_id": "f7449b67-6b87-4786-9786-4fbc7889c453",
          "role": "CUSTOMER",
          "name": "testtt",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "813202444444",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1701533617924,
          "updated_at": 1701533617924,
          "deleted_at": null
        }
      },
      {
        "id": "f16067e7-cd4d-4130-9304-4eaa9eab1245",
        "created_by": null,
        "qoyod_id": null,
        "type": "ORGANIZATION",
        "tax_number": "1231231",
        "zip_code": "1231231",
        "city": "JKT",
        "district": "SAU",
        "street": "SEA",
        "crn": "1223344",
        "user": {
          "id": "086ced3d-d3f9-48c2-8c6f-3f078733885c",
          "userable_id": "f16067e7-cd4d-4130-9304-4eaa9eab1245",
          "role": "CUSTOMER",
          "name": "Tes oo",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "12345678910",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703842254995,
          "updated_at": 1703842254995,
          "deleted_at": null
        }
      },
      {
        "id": "efda697a-0957-4b87-8e9a-7fcacedac419",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "77588bc6-425b-420c-97b9-af00c70dae52",
          "userable_id": "efda697a-0957-4b87-8e9a-7fcacedac419",
          "role": "CUSTOMER",
          "name": "36",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "536666666",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1697707864533,
          "updated_at": 1697707864533,
          "deleted_at": null
        }
      },
      {
        "id": "ec4b2ab6-f67d-4261-bca9-e8f77789a968",
        "created_by": null,
        "qoyod_id": null,
        "type": "ORGANIZATION",
        "tax_number": "012990123123",
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": "091290390",
        "user": {
          "id": "9941b80c-d359-45cf-a66f-f61769b268e1",
          "userable_id": "ec4b2ab6-f67d-4261-bca9-e8f77789a968",
          "role": "CUSTOMER",
          "name": "examexam",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "012930192",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703746124032,
          "updated_at": 1703746124032,
          "deleted_at": null
        }
      },
      {
        "id": "e457196e-1499-4903-81bf-5ea6adf3d746",
        "created_by": null,
        "qoyod_id": null,
        "type": "INDIVIDUAL",
        "gender": "FEMALE",
        "user": {
          "id": "1c64c285-c405-4fa9-82e0-ae666be7840c",
          "userable_id": "e457196e-1499-4903-81bf-5ea6adf3d746",
          "role": "CUSTOMER",
          "name": "Test Gender Female",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "532132132",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703730180146,
          "updated_at": 1703730180146,
          "deleted_at": null
        }
      },
      {
        "id": "e4140f3a-4383-40c9-a6ef-cbcbded4a2cd",
        "created_by": null,
        "qoyod_id": null,
        "type": "INDIVIDUAL",
        "gender": "MALE",
        "user": {
          "id": "86129f07-640d-4691-a93e-595e031c123b",
          "userable_id": "e4140f3a-4383-40c9-a6ef-cbcbded4a2cd",
          "role": "CUSTOMER",
          "name": "testing2",
          "username": null,
          "email": null,
          "phone_prefix": "968",
          "phone": "12321231231",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703732109548,
          "updated_at": 1703732109548,
          "deleted_at": null
        }
      },
      {
        "id": "d6eae41a-385d-4e6d-ae39-7fdacb5873b3",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "eaf5870c-a1f6-4f5d-9bcd-affd74ecad4b",
          "userable_id": "d6eae41a-385d-4e6d-ae39-7fdacb5873b3",
          "role": "CUSTOMER",
          "name": "tetetetes",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "561161619191919",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1697544599090,
          "updated_at": 1697544599090,
          "deleted_at": null
        }
      },
      {
        "id": "d5370ac0-ba0f-4552-b12d-73dbd6682c2c",
        "created_by": null,
        "qoyod_id": null,
        "type": "ORGANIZATION",
        "tax_number": "987654",
        "zip_code": "98765",
        "city": null,
        "district": null,
        "street": null,
        "crn": "987655",
        "user": {
          "id": "0b953ba0-9d40-4c09-ab37-a3486bf09cb4",
          "userable_id": "d5370ac0-ba0f-4552-b12d-73dbd6682c2c",
          "role": "CUSTOMER",
          "name": "Test Org2",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "987654321",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703811085718,
          "updated_at": 1703811085718,
          "deleted_at": null
        }
      },
      {
        "id": "c78500ee-230d-4f08-a566-11470446cf70",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "d7c09b79-f938-4a9b-bbe3-e2ff93033131",
          "userable_id": "c78500ee-230d-4f08-a566-11470446cf70",
          "role": "CUSTOMER",
          "name": "35",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "535555555",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1697707797245,
          "updated_at": 1697707797245,
          "deleted_at": null
        }
      },
      {
        "id": "c53c30a1-fcc1-4884-805c-36ac986a1255",
        "created_by": null,
        "qoyod_id": null,
        "type": "ORGANIZATION",
        "tax_number": "2323",
        "zip_code": "2323",
        "city": "2323",
        "district": "2332",
        "street": "3223",
        "crn": "2332",
        "user": {
          "id": "150518c6-e9f8-4187-b215-658dacfc4178",
          "userable_id": "c53c30a1-fcc1-4884-805c-36ac986a1255",
          "role": "CUSTOMER",
          "name": "User 565",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "565656565",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1680628886144,
          "updated_at": 1680628886145,
          "deleted_at": null
        }
      },
      {
        "id": "c5261b23-6885-4677-a76d-28017acd02f3",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "4265c173-d334-4d0a-adbf-49622c988d4e",
          "userable_id": "c5261b23-6885-4677-a76d-28017acd02f3",
          "role": "CUSTOMER",
          "name": "test1",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "81320244664444",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1701533463430,
          "updated_at": 1701533463430,
          "deleted_at": null
        }
      },
      {
        "id": "c05582ab-b751-4d53-bfda-413bfd29e9c3",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "1e963413-da80-4239-9425-db94c2971a9b",
          "userable_id": "c05582ab-b751-4d53-bfda-413bfd29e9c3",
          "role": "CUSTOMER",
          "name": "Reza",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "8765544321",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703127259106,
          "updated_at": 1703127259106,
          "deleted_at": null
        }
      },
      {
        "id": "be5b4d86-c9d4-4928-97cc-694e4d6dc23e",
        "created_by": null,
        "qoyod_id": null,
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "c84190f4-4b10-41fc-96e6-3442304fade4",
          "userable_id": "be5b4d86-c9d4-4928-97cc-694e4d6dc23e",
          "role": "CUSTOMER",
          "name": "987654323",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "987654323",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703814071282,
          "updated_at": 1703814071282,
          "deleted_at": null
        }
      },
      {
        "id": "bc695673-99df-453f-a006-977a63b7a47d",
        "created_by": null,
        "qoyod_id": "56",
        "type": null,
        "gender": null,
        "tax_number": null,
        "zip_code": null,
        "city": null,
        "district": null,
        "street": null,
        "crn": null,
        "user": {
          "id": "87ab77be-698d-4df4-a00f-40f400c5473c",
          "userable_id": "bc695673-99df-453f-a006-977a63b7a47d",
          "role": "CUSTOMER",
          "name": "Aldila",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "0101010101",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1680305023689,
          "updated_at": 1684063289734,
          "deleted_at": null
        }
      },
      {
        "id": "b9f26082-7c00-4b22-8d08-045d3bddd753",
        "created_by": null,
        "qoyod_id": null,
        "type": "INDIVIDUAL",
        "gender": "FEMALE",
        "user": {
          "id": "3f05b569-1fbf-440d-aa9b-59cd0ba9741a",
          "userable_id": "b9f26082-7c00-4b22-8d08-045d3bddd753",
          "role": "CUSTOMER",
          "name": "Test Female ID",
          "username": null,
          "email": null,
          "phone_prefix": "62",
          "phone": "8877665544",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703814259853,
          "updated_at": 1703814259853,
          "deleted_at": null
        }
      },
      {
        "id": "b81ef3a5-4bb8-4d10-a216-d08e4f25f2fb",
        "created_by": null,
        "qoyod_id": null,
        "type": "INDIVIDUAL",
        "gender": "MALE",
        "user": {
          "id": "f58deb11-3bcf-4933-9dec-b6cd7541956d",
          "userable_id": "b81ef3a5-4bb8-4d10-a216-d08e4f25f2fb",
          "role": "CUSTOMER",
          "name": "Zero1",
          "username": null,
          "email": null,
          "phone_prefix": "966",
          "phone": "500111000",
          "lang": "en",
          "fcm_token": null,
          "is_active": true,
          "email_verified_at": null,
          "phone_verified_at": null,
          "created_at": 1703747606083,
          "updated_at": 1703747606083,
          "deleted_at": null
        }
      }
    ],
    "first_page_url": "http://172.31.31.132/api/v2/customers?page=1",
    "from": 1,
    "last_page": 4,
    "last_page_url": "http://172.31.31.132/api/v2/customers?page=4",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "http://172.31.31.132/api/v2/customers?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http://172.31.31.132/api/v2/customers?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "http://172.31.31.132/api/v2/customers?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "http://172.31.31.132/api/v2/customers?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "http://172.31.31.132/api/v2/customers?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "next_page_url": "http://172.31.31.132/api/v2/customers?page=2",
    "path": "http://172.31.31.132/api/v2/customers",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 76
  }
}
Last modified: a month ago