GET
/
v3
/
user
curl --request GET \
  --url https://safe.dfda.earth/api/v3/user \
  --header 'Authorization: Bearer <token>'
{
  "accessToken": "<string>",
  "accessTokenExpires": "<string>",
  "accessTokenExpiresAtMilliseconds": 123,
  "administrator": true,
  "avatar": "<string>",
  "avatarImage": "<string>",
  "capabilities": "<string>",
  "card": {
    "actionSheetButtons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "avatar": "<string>",
    "avatarCircular": "<string>",
    "backgroundColor": "<string>",
    "buttons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "buttonsSecondary": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "content": "<string>",
    "headerTitle": "<string>",
    "html": "<string>",
    "htmlContent": "<string>",
    "id": "<string>",
    "image": "<string>",
    "inputFields": [
      {
        "displayName": "<string>",
        "helpText": "<string>",
        "hint": "<string>",
        "icon": "<string>",
        "id": "<string>",
        "image": "<string>",
        "key": "<string>",
        "labelLeft": "<string>",
        "labelRight": "<string>",
        "link": "<string>",
        "maxLength": 123,
        "maxValue": 123,
        "minLength": 123,
        "minValue": 123,
        "options": [
          "<string>"
        ],
        "placeholder": "<string>",
        "postUrl": "<string>",
        "required": true,
        "show": true,
        "submitButton": {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        },
        "type": "check_box",
        "validationPattern": "<string>",
        "value": "<string>"
      }
    ],
    "ionIcon": "<string>",
    "link": "<string>",
    "parameters": {},
    "selectedButton": {
      "accessibilityText": "<string>",
      "action": {},
      "additionalInformation": "<string>",
      "color": "<string>",
      "confirmationText": "<string>",
      "functionName": "<string>",
      "parameters": {},
      "html": "<string>",
      "id": "<string>",
      "image": "<string>",
      "ionIcon": "<string>",
      "link": "<string>",
      "stateName": "<string>",
      "stateParams": {},
      "successToastText": "<string>",
      "successAlertTitle": "<string>",
      "successAlertBody": "<string>",
      "text": "<string>",
      "tooltip": "<string>",
      "webhookUrl": "<string>"
    },
    "sharingBody": "<string>",
    "sharingButtons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "sharingTitle": "<string>",
    "subHeader": "<string>",
    "subTitle": "<string>",
    "title": "<string>"
  },
  "clientId": "<string>",
  "clientUserId": "<string>",
  "combineNotifications": true,
  "createdAt": "<string>",
  "description": "<string>",
  "displayName": "<string>",
  "earliestReminderTime": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "getPreviewBuilds": true,
  "hasAndroidApp": true,
  "hasChromeExtension": true,
  "hasIosApp": true,
  "id": 123,
  "lastActive": "<string>",
  "lastFour": "<string>",
  "lastName": "<string>",
  "lastSmsTrackingReminderNotificationId": "<string>",
  "latestReminderTime": "<string>",
  "loginName": "<string>",
  "password": "<string>",
  "phoneNumber": "<string>",
  "phoneVerificationCode": "<string>",
  "primaryOutcomeVariableId": 123,
  "primaryOutcomeVariableName": "<string>",
  "pushNotificationsEnabled": true,
  "refreshToken": "<string>",
  "roles": "<string>",
  "sendPredictorEmails": true,
  "sendReminderNotificationEmails": true,
  "shareAllData": true,
  "smsNotificationsEnabled": true,
  "stripeActive": true,
  "stripeId": "<string>",
  "stripePlan": "<string>",
  "stripeSubscription": "<string>",
  "subscriptionEndsAt": "<string>",
  "subscriptionProvider": "<string>",
  "timeZoneOffset": 123,
  "trackLocation": true,
  "updatedAt": "<string>",
  "userRegistered": "<string>",
  "userUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Query Parameters

​
createdAt
string

When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

​
updatedAt
string

When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

​
limit
integer
default:100

The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.

​
offset
integer

OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.

Required range: x >= 0
​
sort
string

Sort by one of the listed field names. If the field name is prefixed with -, it will sort in descending order.

​
clientId
string

Your client id can be obtained by creating an app at https://builder.quantimo.do

​
clientUserId
integer

Ex: 74802

​
includeAuthorizedClients
boolean

Return list of apps, studies, and individuals with access to user data

Response

200
application/json

Successful operation

The response is of type object.