GET
/
v3
/
shares
Get Authorized Apps, Studies, and Individuals
curl --request GET \
  --url https://safe.dfda.earth/api/v3/shares \
  --header 'Authorization: Bearer <token>'
{
  "authorizedClients": {
    "apps": [
      {
        "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": [
                "<any>"
              ],
              "avatar": "<string>",
              "avatarCircular": "<string>",
              "backgroundColor": "<string>",
              "buttons": [
                "<any>"
              ],
              "buttonsSecondary": [
                "<any>"
              ],
              "content": "<string>",
              "headerTitle": "<string>",
              "html": "<string>",
              "htmlContent": "<string>",
              "id": "<string>",
              "image": "<string>",
              "inputFields": [
                "<any>"
              ],
              "ionIcon": "<string>",
              "link": "<string>",
              "parameters": {},
              "selectedButton": {},
              "sharingBody": "<string>",
              "sharingButtons": [
                "<any>"
              ],
              "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": [
                "<any>"
              ],
              "avatar": "<string>",
              "avatarCircular": "<string>",
              "backgroundColor": "<string>",
              "buttons": [
                "<any>"
              ],
              "buttonsSecondary": [
                "<any>"
              ],
              "content": "<string>",
              "headerTitle": "<string>",
              "html": "<string>",
              "htmlContent": "<string>",
              "id": "<string>",
              "image": "<string>",
              "inputFields": [
                "<any>"
              ],
              "ionIcon": "<string>",
              "link": "<string>",
              "parameters": {},
              "selectedButton": {},
              "sharingBody": "<string>",
              "sharingButtons": [
                "<any>"
              ],
              "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>"
      }
    ],
    "individuals": [
      {
        "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": [
                "<any>"
              ],
              "avatar": "<string>",
              "avatarCircular": "<string>",
              "backgroundColor": "<string>",
              "buttons": [
                "<any>"
              ],
              "buttonsSecondary": [
                "<any>"
              ],
              "content": "<string>",
              "headerTitle": "<string>",
              "html": "<string>",
              "htmlContent": "<string>",
              "id": "<string>",
              "image": "<string>",
              "inputFields": [
                "<any>"
              ],
              "ionIcon": "<string>",
              "link": "<string>",
              "parameters": {},
              "selectedButton": {},
              "sharingBody": "<string>",
              "sharingButtons": [
                "<any>"
              ],
              "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": [
                "<any>"
              ],
              "avatar": "<string>",
              "avatarCircular": "<string>",
              "backgroundColor": "<string>",
              "buttons": [
                "<any>"
              ],
              "buttonsSecondary": [
                "<any>"
              ],
              "content": "<string>",
              "headerTitle": "<string>",
              "html": "<string>",
              "htmlContent": "<string>",
              "id": "<string>",
              "image": "<string>",
              "inputFields": [
                "<any>"
              ],
              "ionIcon": "<string>",
              "link": "<string>",
              "parameters": {},
              "selectedButton": {},
              "sharingBody": "<string>",
              "sharingButtons": [
                "<any>"
              ],
              "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>"
      }
    ],
    "studies": [
      {
        "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": [
                "<any>"
              ],
              "avatar": "<string>",
              "avatarCircular": "<string>",
              "backgroundColor": "<string>",
              "buttons": [
                "<any>"
              ],
              "buttonsSecondary": [
                "<any>"
              ],
              "content": "<string>",
              "headerTitle": "<string>",
              "html": "<string>",
              "htmlContent": "<string>",
              "id": "<string>",
              "image": "<string>",
              "inputFields": [
                "<any>"
              ],
              "ionIcon": "<string>",
              "link": "<string>",
              "parameters": {},
              "selectedButton": {},
              "sharingBody": "<string>",
              "sharingButtons": [
                "<any>"
              ],
              "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": [
                "<any>"
              ],
              "avatar": "<string>",
              "avatarCircular": "<string>",
              "backgroundColor": "<string>",
              "buttons": [
                "<any>"
              ],
              "buttonsSecondary": [
                "<any>"
              ],
              "content": "<string>",
              "headerTitle": "<string>",
              "html": "<string>",
              "htmlContent": "<string>",
              "id": "<string>",
              "image": "<string>",
              "inputFields": [
                "<any>"
              ],
              "ionIcon": "<string>",
              "link": "<string>",
              "parameters": {},
              "selectedButton": {},
              "sharingBody": "<string>",
              "sharingButtons": [
                "<any>"
              ],
              "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": [
      "<any>"
    ],
    "avatar": "<string>",
    "avatarCircular": "<string>",
    "backgroundColor": "<string>",
    "buttons": [
      "<any>"
    ],
    "buttonsSecondary": [
      "<any>"
    ],
    "content": "<string>",
    "headerTitle": "<string>",
    "html": "<string>",
    "htmlContent": "<string>",
    "id": "<string>",
    "image": "<string>",
    "inputFields": [
      "<any>"
    ],
    "ionIcon": "<string>",
    "link": "<string>",
    "parameters": {},
    "selectedButton": {},
    "sharingBody": "<string>",
    "sharingButtons": [
      "<any>"
    ],
    "sharingTitle": "<string>",
    "subHeader": "<string>",
    "subTitle": "<string>",
    "title": "<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.

​
clientId
string

Your client id can be obtained by creating an app 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

​
authorizedClients
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