---
title: "Get user info"
method: GET
path: "/v3/user"
tags: ["user"]
---

# Get user info

`GET /v3/user`

Returns user info.  If no userId is specified, returns info for currently authenticated user

## Query parameters

- `userId` number
- `createdAt` string
- `updatedAt` string
- `limit` integer
- `offset` integer
- `sort` string
- `clientId` string
- `appVersion` string
- `clientUserId` integer
- `log` string
- `pwd` string
- `includeAuthorizedClients` boolean

## Response `200`

Successful operation

- User
  - `accessToken` string, required — User access token
  - `accessTokenExpires` string — Ex: 2018-08-08 02:41:19
  - `accessTokenExpiresAtMilliseconds` integer — Ex: 1533696079000
  - `administrator` boolean, required — Is user administrator
  - `authorizedClients` AuthorizedClients
    - `apps` AppSettings[], required — Applications with access to user measurements for all variables
      - `additionalSettings` object
      - `appDescription` string
      - `appDesign` object
      - `appDisplayName` string
      - `appStatus` object
      - `appType` string
      - `buildEnabled` string
      - `clientId` string — Get yours at https:://builder.quantimo.do
      - `clientSecret` string — Get yours at https:://builder.quantimo.do
      - `collaborators` User[]
      - `createdAt` string
      - `userId` integer — User id of the owner of the application
      - `users` User[]
      - `redirectUri` string
      - `companyName` string
      - `homepageUrl` string
      - `iconUrl` string
      - `longDescription` string
      - `splashScreen` string
      - `textLogo` string
    - `individuals` AppSettings[], required — Individuals such as physicians or family members with access to user measurements for all variables
      - `additionalSettings` object
      - `appDescription` string
      - `appDesign` object
      - `appDisplayName` string
      - `appStatus` object
      - `appType` string
      - `buildEnabled` string
      - `clientId` string — Get yours at https:://builder.quantimo.do
      - `clientSecret` string — Get yours at https:://builder.quantimo.do
      - `collaborators` User[]
      - `createdAt` string
      - `userId` integer — User id of the owner of the application
      - `users` User[]
      - `redirectUri` string
      - `companyName` string
      - `homepageUrl` string
      - `iconUrl` string
      - `longDescription` string
      - `splashScreen` string
      - `textLogo` string
    - `studies` AppSettings[], required — Studies with access to generally anonymous user measurements for a specific predictor and outcome variable
      - `additionalSettings` object
      - `appDescription` string
      - `appDesign` object
      - `appDisplayName` string
      - `appStatus` object
      - `appType` string
      - `buildEnabled` string
      - `clientId` string — Get yours at https:://builder.quantimo.do
      - `clientSecret` string — Get yours at https:://builder.quantimo.do
      - `collaborators` User[]
      - `createdAt` string
      - `userId` integer — User id of the owner of the application
      - `users` User[]
      - `redirectUri` string
      - `companyName` string
      - `homepageUrl` string
      - `iconUrl` string
      - `longDescription` string
      - `splashScreen` string
      - `textLogo` string
  - `avatar` string — Ex: https://lh6.googleusercontent.com/-BHr4hyUWqZU/AAAAAAAAAAI/AAAAAAAIG28/2Lv0en738II/photo.jpg?sz=50
  - `avatarImage` string — Ex: https://lh6.googleusercontent.com/-BHr4hyUWqZU/AAAAAAAAAAI/AAAAAAAIG28/2Lv0en738II/photo.jpg?sz=50
  - `capabilities` string — Ex: a:1:{s:13:"administrator";b:1;}
  - `card` Card
    - `actionSheetButtons` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `avatar` string — Smaller square image
    - `avatarCircular` string — Smaller circular image
    - `backgroundColor` string — Ex: #f2f2f2
    - `buttons` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `buttonsSecondary` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `content` string — Ex: Content
    - `headerTitle` string — Ex: Title
    - `html` string — HTML for the entire card.
    - `htmlContent` string — Ex: <div>Content</div>
    - `id` string, required — HTML element id
    - `image` string — Larger image of variable dimensions
    - `inputFields` InputField[]
      - `displayName` string, required
      - `helpText` string
      - `hint` string
      - `icon` string
      - `id` string — HTML element id
      - `image` string
      - `key` string
      - `labelLeft` string
      - `labelRight` string
      - `link` string
      - `maxLength` integer
      - `maxValue` number
      - `minLength` integer
      - `minValue` number
      - `options` string[] — Selector list options
      - `placeholder` string — Ex: Title
      - `postUrl` string
      - `required` boolean
      - `show` boolean — Ex: Title
      - `submitButton` Button
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `type` 'check_box' | 'date' | 'email' | 'number' | 'postal_code' | 'select_option' | 'string' | 'switch' | 'text_area' | 'unit' | 'variable_category', required — Ex: Title
      - `validationPattern` string — See http://html5pattern.com/ for examples
      - `value` string
    - `ionIcon` string — Ex: ion-refresh
    - `link` string — A link to a web page or something. Not much more to say about that.
    - `parameters` object — Key value pairs derived from user input fields, button clicks, or preset defaults
    - `relatedCards` Card[]
    - `selectedButton` Button
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `sharingBody` string — Ex: sharingBody
    - `sharingButtons` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `sharingTitle` string — Ex: sharingTitle
    - `subHeader` string — Ex: subTitle
    - `subTitle` string — Ex: subTitle
    - `title` string — Ex: Title
  - `clientId` string — Ex: curedao
  - `clientUserId` string — Ex: 118444693184829555362
  - `combineNotifications` boolean — Ex: 1
  - `createdAt` string — When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
  - `description` string — Your bio will be displayed on your published studies
  - `displayName` string, required — User display name
  - `earliestReminderTime` string — Earliest time user should get notifications. Ex: 05:00:00
  - `email` string, required — User email
  - `firstName` string — Ex: Mike
  - `getPreviewBuilds` boolean — Ex: false
  - `hasAndroidApp` boolean — Ex: false
  - `hasChromeExtension` boolean — Ex: false
  - `hasIosApp` boolean — Ex: false
  - `id` integer, required — User id
  - `lastActive` string — Ex: Date the user last logged in
  - `lastFour` string — Ex: 2009
  - `lastName` string — Ex: Sinn
  - `lastSmsTrackingReminderNotificationId` string — Ex: 1
  - `latestReminderTime` string — Latest time user should get notifications. Ex: 23:00:00
  - `loginName` string, required — User login name
  - `password` string — Ex: PASSWORD
  - `phoneNumber` string — Ex: 618-391-0002
  - `phoneVerificationCode` string — Ex: 1234
  - `primaryOutcomeVariableId` integer — A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.
  - `primaryOutcomeVariableName` string — A good primary outcome variable is something that you want to improve and that changes inexplicably. For instance, if you have anxiety, back pain or arthritis which is worse on some days than others, these would be good candidates for primary outcome variables. Recording their severity and potential factors will help you identify hidden factors exacerbating or improving them.
  - `pushNotificationsEnabled` boolean — Ex: 1
  - `refreshToken` string — See https://oauth.net/2/grant-types/refresh-token/
  - `roles` string — Ex: ["admin"]
  - `sendPredictorEmails` boolean — Ex: 1
  - `sendReminderNotificationEmails` boolean — Ex: 1
  - `shareAllData` boolean — Share all studies, charts, and measurement data with all other users
  - `smsNotificationsEnabled` boolean — Ex: false
  - `stripeActive` boolean — Ex: 1
  - `stripeId` string — Ex: cus_A8CEmcvl8jwLhV
  - `stripePlan` string — Ex: monthly7
  - `stripeSubscription` string — Ex: sub_ANTx3nOE7nzjQf
  - `subscriptionEndsAt` string — UTC ISO 8601 YYYY-MM-DDThh:mm:ss
  - `subscriptionProvider` string — Ex: google
  - `timeZoneOffset` integer — Ex: 300
  - `trackLocation` boolean — Ex: 1
  - `updatedAt` string — When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
  - `userRegistered` string — Ex: 2013-12-03 15:25:13 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
  - `userUrl` string — Ex: https://plus.google.com/+MikeSinn

## Other responses

- `401` — Not Authenticated

---

[API](https://skmtc.net/quantimo/apis/curedao-unified-health-api.md) · [All operations](https://skmtc.net/quantimo/apis/curedao-unified-health-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/quantimo/curedao-unified-health-api/versions/7ac03025c3d2/schema)