---
title: "GET /api/v1.0/users/{userId}"
method: GET
path: "/api/v1.0/users/{userId}"
tags: ["Users"]
---

# GET /api/v1.0/users/{userId}

`GET /api/v1.0/users/{userId}`

## Path parameters

- `userId` integer, required

## Response `200`

OK

- RestApiResultUserInfo — Rest api result
  - `Data` UserInfo, required — User information
    - `PhoneNumber` string — The user's phone number.
    - `Email` string — The user's email address.
    - `EmailConfirmed` boolean — Indicates if the user's email address has been confirmed.
    - `PreventFromUsingCards` boolean — Indicates if the user is prevented from using cards.
    - `IsUserPhoneNumberBlocked` boolean — Indicates if the user's phone number is blocked.
    - `UserWhiteLabels` UserWhiteLabelInfo[] — List of white label information associated with the user.
      - `WlConfigId` integer — WhiteLabelConfig Id
      - `AppId` string — Brand Id (AppId)
      - `WhiteLabelName` string — WhiteLabel Name
    - `UserId` integer — The unique identifier for the user.
    - `UserName` string — The user's username.
    - `CustomerName` string — The customer's name.
    - `HasLoggedIn` boolean — Indicates if the user has logged in.
    - `DisableAppRatingControl` boolean — Indicates if the app rating control is disabled for the user.
    - `GloballyOptedOut` boolean — Indicates if the user has globally opted out.
    - `CompletedOrderCount` integer — The number of completed orders by the user.
    - `CancelledOrderCount` integer — The number of cancelled orders by the user.
    - `OrderTotalValue` number, double — The total value of orders placed by the user.
    - `TsMostRecentOrder` string, date-time, nullable — The timestamp of the user's most recent order.
    - `TsFirstOrder` string, date-time, nullable — The timestamp of the user's first order.
    - `IsRestaurantUser` boolean — Indicates if the user is a restaurant user.
    - `Installs` AppInstall[] — List of app installs associated with the user.
      - `Name` string — Name of the installed application.
      - `FirstLogin` string, date-time — Date and time of the user's first login to the app.
      - `FirstLoginHuman` string — Human-readable representation of the first login date.
      - `LastActivity` string, date-time — Date and time of the user's last activity in the app.
      - `LastActivityHuman` string — Human-readable representation of the last activity date.
      - `GoogleTokens` integer — Number of Google push notification tokens associated with the app install.
      - `AppleTokens` integer — Number of Apple push notification tokens associated with the app install.
      - `OrderCount` integer — Number of orders placed by the user through this app install.
      - `UserAgentAtSignup` string — User agent string at the time of signup.
      - `UserAgentMostRecent` string — Most recent user agent string used by the user.
    - `DeliveryLocations` DeliveryLocation[] — List of delivery locations associated with the user.
      - `Coordinates` Coordinates — Coordinates
        - `Latitude` number, double — Latitude
        - `Longitude` number, double — Longitude
      - `Building` string — Building
      - `Street` string — Street
      - `Town` string — Town
      - `PostCode` string — Post code
      - `DeliveryInstructions` string — Delivery instructions
      - `PrettyAddressString` string — Formatted, pretty address string
    - `PaymentAccounts` PaymentAccount[] — List of payment accounts associated with the user.
      - `UserId` integer — The user ID associated with the payment account.
      - `PaymentAccountId` integer — Unique identifier for the payment account.
      - `CanRemoveFromCustomerView` boolean — Indicates if the payment account can be removed from the customer view.
      - `Bin` string — Bank Identification Number (BIN) of the payment method.
      - `IsDefaultPaymentMethod` boolean — Indicates if this is the default payment method.
      - `IsVisibleToCustomer` boolean — Indicates if the payment account is visible to the customer.
      - `PaymentAccountType` string — The type of payment account (e.g., card, PayPal).
      - `Description` string — Description of the payment account.
      - `CustomerId` string — The customer ID associated with the payment account.
    - `LanguageId` string — The language identifier for the user.
    - `CurrentLanguageName` string — Current language name for the user.
    - `Languages` Language[] — Available languages that the user can choose from.
      - `LanguageId` string — ISO 639-1 Language Code
      - `DisplayOrder` integer — Display Order
      - `Name` string — Language Name
      - `Enabled` boolean — Is the language enabled for use.
    - `SalesForceContactId` string — The Salesforce contact ID for the user.
    - `StripeCustomerId` string — The Stripe customer ID for the user.
    - `UserMonthlyCommissions` UserMonthlyCommission[] — User's monthly commissions.
      - `UserId` integer — The unique identifier of the user.
      - `MonthStart` string, date-time — The start date of the month for which the commission is calculated.
      - `CommissionAmount` number, double — The total commission amount for the user in the specified month.
      - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD' — The currency in which the commission is paid.
      - `IsoCurrency` string — The ISO currency code for the commission currency.

## Other responses

- `400` — BadRequest
- `401` — Authentication has been denied for this request.
- `403` — Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)