Get Multiple End Users

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

Returns a list of all your end users.

---

Retrieve a single, specific end user by executing a Get End User request.

Request

Query Parameters

Parameter	Description
accountRole string	Filters the users included in the response by their account_role . Possible values: client , advisor

Example Requests

Shell

#Retrieve all end users
curl -H "Authorization: Bearer ${ENTERPRISE_API_TOKEN}" \
 'https://api.sfox.com/v1/enterprise/users'
 
 #Retrieve all end users with account_role = client
curl -H "Authorization: Bearer ${ENTERPRISE_API_TOKEN}" \
 'https://api.sfox.com/v1/enterprise/users?accountRole=client'
 
  #Retrieve all end users with account_role = advisor
curl -H "Authorization: Bearer ${ENTERPRISE_API_TOKEN}" \
 'https://api.sfox.com/v1/enterprise/users?accountRole=advisor'

NodeJS

//Retrieve all end users
const axios = require('axios');

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

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



//Retrieve all end users with account_role = client
const axios = require('axios');

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

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

  
  
//Retrieve all end users with account_role = advisor
const axios = require('axios');

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

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

#Retrieve all end users
import requests
import os

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


#Retrieve all end users with account_role = client
import requests
import os

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


#Retrieve all end users with account_role = advisor
import requests
import os

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

---

Response

Returns a data array of end user objects with the following fields.

Response Fields

Field	Description
account_type string	The end user's account type. Possible values: individual, corporation
account_role string	The end user's role. Possible values: Client, Advisor
user_id string	End user's unique ID, defined by you.
advisor_user_id nullable, string	user_id of the end user's, if applicable.
email string	Email address of the user.
first_name string	First name of the user.
last_name string	Last name of the user.
phone_number string	Phone number of the user in E.164 format (e.g. [phone]).
status string	Verification status of the user’s sFOX account. Possible values: PENDING, VERIFIED, UNSUPPORTED
requirements object	The remaining requirements to complete account verification.

Responses

200: OK

{
  "data": [{
    "account_type": "individual",
    "account_role": "Client",
    "user_id": "client_account_1",
    "advisor_user_id": "advisor_account_1",
    "email": "[email protected]",
    "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",
    "advisor_user_id": null,
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone_number": "[phone]",
    "status": "VERIFIED",
    "requirements": {
      "email": false,
      "sms": false
    }
  }]
}