Skip to main content
GET
/
v3
/
users
Get users who shared data
curl --request GET \
  --url https://safe.dfda.earth/api/v3/users \
  --header 'Authorization: Bearer <token>'
{
  "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": [
              "<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>"
    }
  ],
  "description": "<string>",
  "summary": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "status": "<string>",
  "success": true,
  "code": 123,
  "image": {
    "height": "<string>",
    "imageUrl": "<string>",
    "width": "<string>"
  },
  "avatar": "<string>",
  "ionIcon": "<string>",
  "html": "<string>",
  "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": [
          "<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>"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Query Parameters

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

Response

Successful operation

​
users
object[]
required
​
description
string

Users who granted access to their data

​
summary
string

Users who granted access to their data

​
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

​
image
object
​
avatar
string

Square icon png url

​
ionIcon
string

Ex: ion-ios-person

​
html
string

Users who granted access to their data

​
link
string

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

​
card
object
⌘I