Skip to main content
GET
/
v3
/
appSettings
Get client app settings
curl --request GET \
  --url https://safe.dfda.earth/api/v3/appSettings
{
  "appSettings": {
    "additionalSettings": {},
    "appDescription": "<string>",
    "appDesign": {},
    "appDisplayName": "<string>",
    "appStatus": {},
    "appType": "<string>",
    "buildEnabled": "<string>",
    "clientId": "<string>",
    "clientSecret": "<string>",
    "collaborators": [
      {
        "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": [
                "<any>"
              ],
              "placeholder": "<string>",
              "postUrl": "<string>",
              "required": true,
              "show": true,
              "submitButton": {},
              "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>"
      }
    ],
    "createdAt": "<string>",
    "userId": 123,
    "users": [
      {
        "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": [
                "<any>"
              ],
              "placeholder": "<string>",
              "postUrl": "<string>",
              "required": true,
              "show": true,
              "submitButton": {},
              "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>"
      }
    ],
    "redirectUri": "<string>",
    "companyName": "<string>",
    "homepageUrl": "<string>",
    "iconUrl": "<string>",
    "longDescription": "<string>",
    "splashScreen": "<string>",
    "textLogo": "<string>"
  },
  "description": "<string>",
  "summary": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "status": "<string>",
  "success": true,
  "code": 123,
  "link": "<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": [
          "<any>"
        ],
        "placeholder": "<string>",
        "postUrl": "<string>",
        "required": true,
        "show": true,
        "submitButton": {},
        "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>"
  }
}

Query Parameters

​
clientId
string

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

​
client_secret
string

This is the secret for your obtained clientId. We use this to ensure that only your application uses the clientId. Obtain this by creating a free application at https://builder.quantimo.do.

Response

Successful operation

​
description
string
required

Can be used as body of help info popup

​
summary
string
required

Can be used as title in help info popup

​
appSettings
object
​
errors
object[]

Array of error objects with message property

​
status
string

ex. OK or ERROR

​
success
boolean

true or false

​
code
number

Response code such as 200

​
link
string

A super neat url you might want to share with your users!

​
card
object