Show Developer Menu

GET /staff

Issuing a GET call to staff will allow you to retrieve staff users for the Account.

Example Request
curl 'https://{brand}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
  "page_size": 30,
  "page_count": 1,
  "total_count": 10,
  "staff": [
      "name": "Jean Super Agent",
      "created_at": "2012-09-01T12:13:14.123Z"
      "email": "",
      "role": {
  • The resulting staff list is sorted by created_at.
  • role is a hash of permissions. Currently the Role resource is not supported by API so we advise against using the values there except as general information about the users capacity in the system. Future permission keys may be subject to change.