# Whoami

This endpoint returns information about the business, the business owner, and the access token scopes

# The Whoami Object

# Sample

{
  "oauth_client": {
    "id": "9598beea-692a-49b9-97da-ada78cec3752",
    "name": "Alex Ralph"
  },
  "user": {
    "pin": "*****",
    "is_owner": true,
    "branches": [],
    "roles": [],
    "id": "9598b465-c80a-441c-b383-2890746b1a08",
    "name": "Alex Ralph",
    "number": "1",
    "email": "alexralph@Ristecho.com",
    "phone": "12345678",
    "lang": "en",
    "display_localized_names": false,
    "email_verified": true,
    "must_use_fingerprint": false,
    "last_console_login_at": "2022-05-11 14:05:02",
    "last_cashier_login_at": null,
    "created_at": "2022-02-14 09:29:27",
    "updated_at": "2022-05-11 14:05:02",
    "deleted_at": null
  },
  "device": null,
  "is_owner": true,
  "scopes": [
    "general.read",
    "orders.list"
  ],
  "business": {
    "id": "9598b465-dd92-4eba-a2e0-ac7cd1d2cca0",
    "name": "Alex Ralph's Business",
    "country_iso_code": "SA",
    "owner_id": "9598b465-c80a-441c-b383-2890746b1a08",
    "owner_email": "alexralph@Ristecho.com",
    "reference": 526215,
    "trial_ends_at": null,
    "has_pending_invoice": false,
    "has_Ristecho_pay": false,
    "addons": [
      "combos",
      "coupons",
      "dashboard_branches",
      "delivery_zones",
      "export_customers",
      "export_orders",
      "export_transactions",
      "groups",
      "house_account",
      "inventory_cost_adjustment",
      "inventory_production",
      "inventory_purchase_orders",
      "inventory_transfer_orders",
      "inventory_transfers",
      "marketplace",
      "promotions",
      "reports_analysis",
      "reports_group_by",
      "sections_tables",
      "tags",
      "timed_events",
      "loyalty",
      "gift_cards",
      "digital_receipt",
      "online_store",
      "web_cashier",
      "dashboard_inventory",
      "inventory_categories",
      "inventory_count",
      "inventory_items",
      "inventory_purchasing",
      "inventory_quantity_adjustment",
      "inventory_suppliers"
    ],
    "licenses": {
      "branch": 2,
      "warehouse": 1,
      "cashier": 2,
      "sub_cashier": 0,
      "kds": 0,
      "waiter": 0,
      "notifier": 0,
      "display": 0,
      "menu": 0,
      "kiosk": 0,
      "agent": 1,
      "simple_cashier": 0
    },
    "is_blocked": false,
    "created_at": "2022-02-14 09:29:01",
    "updated_at": "2022-03-10 15:04:23",
    "plan": null,
    "type": 1
  }
}

# Attributes

Field	Type	Description
`user`	`object`	The business Owner details
`oauth_client`	`object`
`device`	`object`
`is_owner`	`boolean`	True if the returned user is an owner of the business
`scopes`	`array`	The token Access Scopes
`business`	`object`	The business object
`business.id`	`string`	The business unique Id
`business.name`	`string`	The business name
`business.country_iso_code`	`string`	The country code of the country where business is operating
`business.owner_id`	`string`	The business owner id
`business.reference`	`number`	The business unique reference
`business.trial_ends_at`	`string`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the business trial period ends
`is_blocked`	`string`	True if the business is blocked

# Get Whoami

GET /whoami

# Response

{
  "data": {
    "oauth_client": {
      "id": "9598beea-692a-49b9-97da-ada78cec3752",
      "name": "Alex Ralph"
    },
    "user": {
      "pin": "*****",
      "is_owner": true,
      "branches": [],
      "roles": [],
      "id": "9598b465-c80a-441c-b383-2890746b1a08",
      "name": "Alex Ralph",
      "number": "1",
      "email": "alexralph@Ristecho.com",
      "phone": "12345678",
      "lang": "en",
      "display_localized_names": false,
      "email_verified": true,
      "must_use_fingerprint": false,
      "last_console_login_at": "2022-05-11 14:05:02",
      "last_cashier_login_at": null,
      "created_at": "2022-02-14 09:29:27",
      "updated_at": "2022-05-11 14:05:02",
      "deleted_at": null
    },
    "device": null,
    "is_owner": true,
    "scopes": [
      "general.read",
      "orders.list"
    ],
    "business": {
      "id": "9598b465-dd92-4eba-a2e0-ac7cd1d2cca0",
      "name": "Alex Ralph's Business",
      "country_iso_code": "SA",
      "owner_id": "9598b465-c80a-441c-b383-2890746b1a08",
      "owner_email": "alexralph@Ristecho.com",
      "reference": 526215,
      "trial_ends_at": null,
      "has_pending_invoice": false,
      "has_Ristecho_pay": false,
      "addons": [
        "combos",
        "coupons",
        "dashboard_branches",
        "delivery_zones",
        "export_customers",
        "export_orders",
        "export_transactions",
        "groups",
        "house_account",
        "inventory_cost_adjustment",
        "inventory_production",
        "inventory_purchase_orders",
        "inventory_transfer_orders",
        "inventory_transfers",
        "marketplace",
        "promotions",
        "reports_analysis",
        "reports_group_by",
        "sections_tables",
        "tags",
        "timed_events",
        "loyalty",
        "gift_cards",
        "digital_receipt",
        "online_store",
        "web_cashier",
        "dashboard_inventory",
        "inventory_categories",
        "inventory_count",
        "inventory_items",
        "inventory_purchasing",
        "inventory_quantity_adjustment",
        "inventory_suppliers"
      ],
      "licenses": {
        "branch": 2,
        "warehouse": 1,
        "cashier": 2,
        "sub_cashier": 0,
        "kds": 0,
        "waiter": 0,
        "notifier": 0,
        "display": 0,
        "menu": 0,
        "kiosk": 0,
        "agent": 1,
        "simple_cashier": 0
      },
      "is_blocked": false,
      "created_at": "2022-02-14 09:29:01",
      "updated_at": "2022-03-10 15:04:23",
      "plan": null,
      "type": 1
    }
  }
}

← Users Cost Adjustment Transactions →