Get End User(s)

GET	https://api.sfox.com/v1/enterprise/users/:user_id

Returns a list of all your users that exist within sFOX Connect, or optionally, a single specific user.

---

Request

Query Parameters

Parameter	Type	Description
accountRole	string	Filters the users by either a client or advisor role. Possible values: client or advisor

Path Parameters

Parameter	Type	Description
user_id optional	string	Specific user_id to retrieve

Example Requests

Shell

curl -H "Authorization: Bearer ${ENTERPRISE_API_TOKEN}" \
 'https://api.sfox.com/v1/enterprise/users'

NodeJS

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.sfox.com/v1/enterprise/users',
  headers: {
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_TOKEN}`
  }
}

axios(config)
  .then(response => {
    console.log(response.status)
    console.log(respones.data)
  }).catch(err => {
    console.error(err.response.status)
    console.error(err.response.data)
  });

Python

import requests
import os

data = requests.get(
  "https://api.sfox.com/v1/enterprise/users",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_TOKEN']}"
  }
)
print(data.status_code)
print(data.json())

Response

Response Body

Key	Description
account_type	Individual or Corporation
account_role	Advisor or Client
user_id	Unique ID shared between sFOX and you
email	Email address of the user
first_name	First name of the user
last_name	Last name of the user
phone_number	Phone number of the user
advisor_user_id	User ID of the Advisor to this Client, if applicable
status	Verification status of the user’s sFOX account
requirements	The remaining requirements to complete account verification

Responses

200 OK (all users)

All users

{
    "data": [
      {
        "account_type": "individual",
        "account_role": "Client",
        "user_id": "client_account_1",
        "email": "[e-mail]",
        "first_name": "Sean",
        "last_name": "Fox",
        "phone_number": "[phone]",
        "advisor_user_id": "advisor_account_1",
        "status": "PENDING",
        "requirements": {
            "email": true,
            "sms": true
        }
      },
      {
        "account_type": "individual",
        "account_role": "Advisor",
        "user_id": "advisor_account_1",
        "email": "[e-mail]",
        "first_name": "Jane",
        "last_name": "Doe",
        "phone_number": "[phone]",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
      }
    ]
}

200 OK (specific user)

Specific partnerUserId

{
    "data": {
        "account_type": "individual",
        "account_role": "Client",
        "user_id": "client_account_1",
        "email": "[e-mail]",
        "first_name": "Sean",
        "last_name": "Fox",
        "phone_number": "[phone]",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
    }
}