Me
Current user
The authenticated user with the relations of their role. For a subscriber userable.branch is the pinned branch, with setting (setting.timezone: the branch IANA zone every workday time is computed in) and shift. shift keeps its legacy keys (day, min, max, open_at, lock_at) and adds timezone, is_workday (the branch switch is ON), workday, overtime_end_at, auto_close_at (when the auto-close job will close the open shift) and next_opening_at (additive, at every X-API-Version); from X-API-Version 2.10.0 shift is always an object, below it a branch outside every shift keeps null. Clients that need the phase and the allowed actions read GET /v2/attendances/state instead of deriving them from shift.
Authorization
API-TOKEN API-TOKEN<token>
Your partner API key. Send it in the API-TOKEN header on every request.
In: header
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/me" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"id": "19db2575-dd54-419c-9c98-83f3bf880354",
"userable_id": "fcc7ac90-0ffd-42b7-a08a-a5fa05c8a191",
"role": "USER_SUBSCRIBER",
"name": "Carmen Simonis",
"username": "elbert.bartell",
"email": "[email protected]",
"phone_prefix": "968",
"phone_number": "8408766091",
"lang": "en",
"is_active": true,
"created_at": 1792593340154,
"updated_at": 1792593340154,
"profile_img": "http://localhost:8000/api/v2/users/19db2575-dd54-419c-9c98-83f3bf880354/profile",
"phone": "8408766091",
"userable": {
"id": "fcc7ac90-0ffd-42b7-a08a-a5fa05c8a191",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": "68c6e3fa-9836-4dcc-9a23-3e4bf8ee200e",
"permission_id": 33,
"created_at": null,
"updated_at": null,
"merchant_id": null,
"reseller_id": null,
"registration_token": null,
"registration_stage": "COMPLETE",
"pin_set_at": null,
"pin_must_change": false,
"has_pin": false,
"is_has_products": true,
"is_has_orders": true,
"market": {
"id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"sector_id": 15,
"name_en": "Franecki Ltd",
"name_ar": "Wintheiser-Barrows",
"description_en": "Eaque distinctio fuga nihil vitae velit.",
"description_ar": null,
"logo_img": "https://via.placeholder.com/200x200.png/009955?text=business+logo+facilis",
"cover_img": "https://via.placeholder.com/200x200.png/009999?text=business+cover+amet",
"email": "[email protected]",
"phone_prefix": "967",
"phone_number": "7856586642",
"crn": "033-466-2828",
"tax_number": "66596607090",
"created_by": null,
"email_verified_at": 1792593329562,
"phone_verified_at": 1792593329562,
"created_at": 1792593329465,
"updated_at": 1792593340021,
"deleted_at": null,
"is_active": true,
"slug": "wisoky-feest",
"code": "ENT-0000000001",
"links": {
"website": null,
"instagram": null,
"youtube": null,
"x": null,
"call_center": null
},
"phone": "7856586642",
"sector": {
"id": 15,
"icon": "🍺",
"name_en": "accusamus",
"name_ar": "accusamus",
"type": "COMMON",
"deleted_at": null,
"pages": [],
"features": []
},
"plans": [],
"setting": null
},
"permission": {
"id": 33,
"name": "Administrator",
"pages": [
"ACCOUNT",
"ACCOUNTING_PURCHASE",
"ACCOUNTING_RESUPPLY",
"ACCOUNTING_SUPPLIER",
"ADVERTISEMENT",
"APPLICATION",
"AUTHENTICATION",
"BRANCH",
"BULK_IMPORT",
"CUSTOMER",
"DASHBOARD",
"DEVICE",
"DISCOUNT",
"DRIVER",
"GENERAL_SETTINGS",
"INVENTORY_INGREDIENT",
"INVENTORY_RECIPE",
"INVENTORY_FACTORY",
"KITCHEN",
"ORDER",
"ORDER_TYPE",
"PAYMENT_METHOD",
"PAYMENT_TRANSFER",
"PERMISSION",
"PRODUCT",
"PRODUCT_CATEGORY",
"PROFILE",
"RATING",
"REPORT_ATTENDANCE",
"REPORT_KITCHEN",
"REPORT_WAITER",
"REPORT_ORDER",
"REPORT_PRODUCT",
"REPORT_PURCHASE",
"REPORT_RETURNS",
"REPORT_SUMMARY",
"SCHEDULE",
"SCREEN_CASHIER",
"SCREEN_CUSTOMER",
"SCREEN_WAITING",
"SUBSCRIPTION",
"TABLE",
"TAX",
"WAITER"
],
"others": [
"RETURN_ORDER",
"CASH_DRAWER",
"VERIFY_ORDER_PURCHASE",
"FAST_OFFER",
"SPLIT_PAYMENTS",
"PRINT_INVOICE",
"PAY_NOW",
"PAY_LATER",
"ACCOUNT_CREATE",
"ACCOUNT_UPDATE",
"ACCOUNT_DELETE",
"PERMISSION_CREATE",
"PERMISSION_UPDATE",
"PERMISSION_DELETE",
"ORDER_TYPE_CREATE",
"ORDER_TYPE_UPDATE",
"ORDER_TYPE_DELETE",
"PRODUCT_IMPORT",
"PRODUCT_CATEGORY_IMPORT",
"CUSTOMER_IMPORT",
"INGREDIENT_IMPORT",
"PRODUCT_CATEGORY_CREATE",
"PRODUCT_CATEGORY_UPDATE",
"PRODUCT_CATEGORY_DELETE",
"SESSION_CLOSE_FIGURES"
],
"deleted_at": null,
"permissionable_id": 25,
"permissionable_type": "PERMISSION_SUBSCRIBER",
"is_default": true,
"waiter": null,
"features": [
{
"id": "51542f5e-d6e4-44d7-bdf9-e411251bd36c",
"permission_id": 33,
"feature_key": "ACCOUNT"
},
{
"id": "8c3912a2-ddcb-4473-8e0e-f42d598a0d95",
"permission_id": 33,
"feature_key": "ACCOUNTING_PURCHASE"
},
{
"id": "be0fd5e4-cce9-4dda-b26d-c47ce66fa3f8",
"permission_id": 33,
"feature_key": "ACCOUNTING_RESUPPLY"
},
{
"id": "bf5461ad-4402-4070-b2d5-dc05420df482",
"permission_id": 33,
"feature_key": "ACCOUNTING_SUPPLIER"
},
{
"id": "3385f95e-7899-4f8b-b54b-95a25a00c449",
"permission_id": 33,
"feature_key": "ADVERTISEMENT"
},
{
"id": "93274def-ca3c-40ef-b3ea-3f53ce9c4426",
"permission_id": 33,
"feature_key": "APPLICATION"
},
{
"id": "3b404f5d-b1de-4483-b36b-74a99b60e556",
"permission_id": 33,
"feature_key": "AUTHENTICATION"
},
{
"id": "5af44b8b-fcfe-4971-adfd-5b2778adc381",
"permission_id": 33,
"feature_key": "BRANCH"
},
{
"id": "8608afff-74a4-404f-9fd7-fe6e0655fff8",
"permission_id": 33,
"feature_key": "BULK_IMPORT"
},
{
"id": "c240261d-e0e3-4e95-bcfe-9612931ac0b8",
"permission_id": 33,
"feature_key": "CUSTOMER"
},
{
"id": "8a14c844-acba-4529-bc3c-1434879a3b38",
"permission_id": 33,
"feature_key": "DASHBOARD"
},
{
"id": "22c96bb2-c429-4dd7-b5ba-315d6678fcf6",
"permission_id": 33,
"feature_key": "DEVICE"
},
{
"id": "6453f06c-8c00-4cb5-a99a-32f3d10e376d",
"permission_id": 33,
"feature_key": "DISCOUNT"
},
{
"id": "c8c4f6e9-5a1c-4b87-82bb-82c038a29818",
"permission_id": 33,
"feature_key": "DRIVER"
},
{
"id": "a81558ff-da78-41b6-a364-fb3ab8bc21b2",
"permission_id": 33,
"feature_key": "GENERAL_SETTINGS"
},
{
"id": "0ef7989b-bb98-4781-8735-4383fe91cdbb",
"permission_id": 33,
"feature_key": "INVENTORY_INGREDIENT"
},
{
"id": "93c2642a-d2b4-49ab-9e14-29d3f0e9fde1",
"permission_id": 33,
"feature_key": "INVENTORY_RECIPE"
},
{
"id": "271e6acb-ec64-462a-b2a6-f714ebea6215",
"permission_id": 33,
"feature_key": "INVENTORY_FACTORY"
},
{
"id": "1d7b1cef-309f-4363-8f5f-b2f19448403a",
"permission_id": 33,
"feature_key": "KITCHEN"
},
{
"id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"permission_id": 33,
"feature_key": "ORDER"
},
{
"id": "6d8326df-1df2-46b3-87d9-e36ea720c450",
"permission_id": 33,
"feature_key": "ORDER_TYPE"
},
{
"id": "3453b185-93e5-4451-a6b9-7a2192ea1e42",
"permission_id": 33,
"feature_key": "PAYMENT_METHOD"
},
{
"id": "7cbc22dd-c72c-4030-af3a-a06c12d1ed29",
"permission_id": 33,
"feature_key": "PAYMENT_TRANSFER"
},
{
"id": "37bf4d36-e619-4baa-87b0-e055444a0814",
"permission_id": 33,
"feature_key": "PERMISSION"
},
{
"id": "da230f9d-a84d-44c3-b29e-205bf36ed6d7",
"permission_id": 33,
"feature_key": "PRODUCT"
},
{
"id": "542dd383-1901-43c9-9cc1-24e4e09cda74",
"permission_id": 33,
"feature_key": "PRODUCT_CATEGORY"
},
{
"id": "69ee1766-211f-45e3-b484-425589521142",
"permission_id": 33,
"feature_key": "PROFILE"
},
{
"id": "822cf67b-4de8-4259-9266-bc2570dfe8ff",
"permission_id": 33,
"feature_key": "RATING"
},
{
"id": "ca0185e3-ad6c-4b08-8f7d-d7eb04ed3fad",
"permission_id": 33,
"feature_key": "REPORT_ATTENDANCE"
},
{
"id": "e639d71b-8be8-420c-8ba3-e77823ccc165",
"permission_id": 33,
"feature_key": "REPORT_KITCHEN"
},
{
"id": "c4ce58b2-3868-4ee1-a2fe-01430e625570",
"permission_id": 33,
"feature_key": "REPORT_WAITER"
},
{
"id": "d5bd197e-a950-46cd-bb43-790e9cdf9629",
"permission_id": 33,
"feature_key": "REPORT_ORDER"
},
{
"id": "0b4c9fd1-67af-40c0-b9b7-5b4bce640107",
"permission_id": 33,
"feature_key": "REPORT_PRODUCT"
},
{
"id": "05ac322f-065e-4e78-b4a0-cf6e0285a2d5",
"permission_id": 33,
"feature_key": "REPORT_PURCHASE"
},
{
"id": "5d7ebe0e-fd5c-467a-9765-3a902c6913cb",
"permission_id": 33,
"feature_key": "REPORT_RETURNS"
},
{
"id": "1c2b3666-e9c2-4c2e-9123-3fba5ebd5660",
"permission_id": 33,
"feature_key": "REPORT_SUMMARY"
},
{
"id": "2d992044-b9d1-4e0b-a47e-ddf7591ed6c4",
"permission_id": 33,
"feature_key": "SCHEDULE"
},
{
"id": "b23ad032-5a00-427d-a245-4bfd085f16a8",
"permission_id": 33,
"feature_key": "SCREEN_CASHIER"
},
{
"id": "e890e1b0-5b22-414f-b3f8-23cdc37e5cb6",
"permission_id": 33,
"feature_key": "SCREEN_CUSTOMER"
},
{
"id": "8202ea8a-3ba3-49ec-b1f0-d4cc3de3a27e",
"permission_id": 33,
"feature_key": "SCREEN_WAITING"
},
{
"id": "61cd5c31-97b1-4eba-8954-58b25814bd95",
"permission_id": 33,
"feature_key": "SUBSCRIPTION"
},
{
"id": "decc05f4-9a97-4b07-85d4-9bbde4eeec54",
"permission_id": 33,
"feature_key": "TABLE"
},
{
"id": "08ce0656-e69a-42dc-87df-d1b781a9d18e",
"permission_id": 33,
"feature_key": "TAX"
},
{
"id": "6c6d5ebc-c479-4094-8163-a731fc8cc0cc",
"permission_id": 33,
"feature_key": "WAITER"
}
],
"controls": [
{
"id": "2787429b-5d65-4f0a-b30b-968c41dfb648",
"permission_id": 33,
"feature_id": "51542f5e-d6e4-44d7-bdf9-e411251bd36c",
"control_key": "ACCOUNT_CREATE"
},
{
"id": "d63f1c99-f05a-4c57-acae-a59b13c79f03",
"permission_id": 33,
"feature_id": "51542f5e-d6e4-44d7-bdf9-e411251bd36c",
"control_key": "ACCOUNT_UPDATE"
},
{
"id": "69cd89da-9837-465b-be84-b4cc6a986616",
"permission_id": 33,
"feature_id": "51542f5e-d6e4-44d7-bdf9-e411251bd36c",
"control_key": "ACCOUNT_DELETE"
},
{
"id": "be9ad002-c8f2-4264-b80b-be42fdc994ae",
"permission_id": 33,
"feature_id": "be0fd5e4-cce9-4dda-b26d-c47ce66fa3f8",
"control_key": "RESUPPLY_VERIFY"
},
{
"id": "66d3da0e-4e9e-4b0c-ada2-ea966c3a29a3",
"permission_id": 33,
"feature_id": "8608afff-74a4-404f-9fd7-fe6e0655fff8",
"control_key": "PRODUCT_IMPORT"
},
{
"id": "1e405df1-e65e-493e-807b-fe93e6fc775d",
"permission_id": 33,
"feature_id": "8608afff-74a4-404f-9fd7-fe6e0655fff8",
"control_key": "PRODUCT_CATEGORY_IMPORT"
},
{
"id": "d2829c2b-fad1-4b4d-a750-e772d06c45a8",
"permission_id": 33,
"feature_id": "8608afff-74a4-404f-9fd7-fe6e0655fff8",
"control_key": "CUSTOMER_IMPORT"
},
{
"id": "e7711bd7-ebb3-4e5d-a98a-af6de2df61d9",
"permission_id": 33,
"feature_id": "8608afff-74a4-404f-9fd7-fe6e0655fff8",
"control_key": "INGREDIENT_IMPORT"
},
{
"id": "58b7b6c5-b159-46e1-8e54-a74e03bf105a",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_CASH_DRAWER"
},
{
"id": "64681edb-a17f-41dc-a078-1b8a01bc7cb6",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_FAST_OFFER"
},
{
"id": "8aa656e3-0a0a-4dea-8068-06a15301462e",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_PAY_NOW"
},
{
"id": "46e0ca80-fbad-4064-aaad-482991a969e0",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_PAY_LATER"
},
{
"id": "576c5fd2-f868-4131-9f8b-d834433b4338",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_PRINT_INVOICE"
},
{
"id": "9ccac75e-072a-480f-a71c-a5e7728adcb9",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_RETURN"
},
{
"id": "aaf6f648-db3b-4015-86f7-3ee51447ab93",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_SPLIT_PAYMENT"
},
{
"id": "860a843b-608c-43e7-9636-6bf23332415c",
"permission_id": 33,
"feature_id": "357b66c4-90a7-4eeb-9ed2-b90e201acc99",
"control_key": "ORDER_SESSION_CLOSE_FIGURES"
},
{
"id": "829bbaa6-b6d7-48e1-ac23-594932db417d",
"permission_id": 33,
"feature_id": "6d8326df-1df2-46b3-87d9-e36ea720c450",
"control_key": "ORDER_TYPE_CREATE"
},
{
"id": "aa8620e2-5eda-4eec-966a-bf21c40aef2c",
"permission_id": 33,
"feature_id": "6d8326df-1df2-46b3-87d9-e36ea720c450",
"control_key": "ORDER_TYPE_UPDATE"
},
{
"id": "309fe1c6-c761-4f29-8cca-b5b209c70d41",
"permission_id": 33,
"feature_id": "6d8326df-1df2-46b3-87d9-e36ea720c450",
"control_key": "ORDER_TYPE_DELETE"
},
{
"id": "8e4952d3-a861-4ba4-b2df-a7ad9bad163a",
"permission_id": 33,
"feature_id": "37bf4d36-e619-4baa-87b0-e055444a0814",
"control_key": "PERMISSION_CREATE"
},
{
"id": "d5139616-6999-4a3e-89c7-43d0cca70af1",
"permission_id": 33,
"feature_id": "37bf4d36-e619-4baa-87b0-e055444a0814",
"control_key": "PERMISSION_UPDATE"
},
{
"id": "a1afb034-3206-4007-b61f-ef6fd222a624",
"permission_id": 33,
"feature_id": "37bf4d36-e619-4baa-87b0-e055444a0814",
"control_key": "PERMISSION_DELETE"
},
{
"id": "87d73192-0793-4de1-88c6-68f51988b052",
"permission_id": 33,
"feature_id": "542dd383-1901-43c9-9cc1-24e4e09cda74",
"control_key": "PRODUCT_CATEGORY_CREATE"
},
{
"id": "6e3ab0ba-b7ee-45dd-9a74-60ba309ac85d",
"permission_id": 33,
"feature_id": "542dd383-1901-43c9-9cc1-24e4e09cda74",
"control_key": "PRODUCT_CATEGORY_UPDATE"
},
{
"id": "426b7cd3-e94a-4b43-b5fe-e2689b95de41",
"permission_id": 33,
"feature_id": "542dd383-1901-43c9-9cc1-24e4e09cda74",
"control_key": "PRODUCT_CATEGORY_DELETE"
},
{
"id": "aa06eced-32e7-4dd9-8ca9-62278540a3ad",
"permission_id": 33,
"feature_id": "ca0185e3-ad6c-4b08-8f7d-d7eb04ed3fad",
"control_key": "ATTENDANCE_CASH_COUNT"
}
]
},
"branch": {
"id": "68c6e3fa-9836-4dcc-9a23-3e4bf8ee200e",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Zboncak PLC",
"name_ar": "Zboncak PLC",
"address": "7725 Stokes Manor Suite 040\nSouth Enola, GA 22834-8378",
"latitude": 70.111963,
"longitude": 63.873576,
"is_active": true,
"created_at": 1792593340155,
"updated_at": 1792593340155,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"code": "BR-305640",
"shift": {
"day": "MON",
"min": 1791180000000,
"max": 1791226800000,
"open_at": 1791179400000,
"lock_at": 1791230400000,
"timezone": "Asia/Riyadh",
"is_workday": true,
"workday": "2026-10-05",
"overtime_end_at": 1791230400000,
"auto_close_at": null,
"next_opening_at": 1791266400000
},
"setting": {
"id": 31,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": "68c6e3fa-9836-4dcc-9a23-3e4bf8ee200e",
"is_kitchen_active": true,
"is_pay_later": false,
"invoice_prefix": null,
"zatca_otp": null,
"seating": {
"order": {
"statuses": [
"COMPLETED"
],
"transaction": {
"status": "PAID"
}
}
},
"kitchen": {
"complete_on_last_bump": true,
"courses_enabled": false,
"courses": [],
"kitchen_can_fire": false,
"fire_by_prep_time": false,
"fallback_print_delay_seconds": 60,
"ack_warning_seconds": 15,
"warn_ratio": 0.75,
"late_ratio": 1,
"recall_window_seconds": 900,
"completed_tab_window_seconds": 1800,
"print_owner": "TILL",
"legacy_board": "ON",
"customer_notification": {
"channel": "OFF",
"language": "AR",
"message_en": "Order {order_number} is ready at {branch_name}.",
"message_ar": "طلبك رقم {order_number} جاهز في {branch_name}."
},
"customer_screen": {
"ready_display_seconds": 90,
"number_size": "MEDIUM",
"preparing_tone": "WARNING",
"ready_tone": "SUCCESS",
"layout": "SPLIT",
"hide_sidebar": false,
"hide_back": false,
"hide_branch": false,
"hide_toolbar": false
}
},
"config_version": 0,
"waiter": {
"require_guest_count": false,
"ownership_rule": "SECTION",
"table_warn_minutes": 45,
"table_late_minutes": 90,
"allow_merge": true,
"allow_transfer": true,
"seats": "OPTIONAL",
"override_policy": "MANAGER_PIN",
"tips": {
"enabled": false,
"presets": [
5,
10,
15
],
"allow_custom": true
},
"service_charge_display": "SEPARATE",
"partial_settlement": false,
"pay_at_table_provider": null,
"qr": {
"enabled": false,
"auto_accept": false,
"reject_reasons": [],
"pending_minutes": 15
},
"table_service": "FULL",
"pin_lockout": {
"attempts": 5,
"seconds": 60
}
},
"waiter_config_version": 0,
"waiter_catalog_version": 1,
"timezone": "Asia/Riyadh"
},
"plans": []
}
},
"devices": []
}
}{
"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
}