Employees

List the employees of the agency

GET/v1/employees

Lists the active members of the agency. Employees are agency-level: the creator scope of the key does not apply. Use this endpoint to resolve the employee ids returned by assignments and attributions.

Required scoperead:employees

Rate limit60 requests per minute

curl 'https://api.fansquare.so/v1/employees' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
      "username": "sam_chat",
      "role": "chatter"
    }
  ]
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Response

OK, application/json

dataarray of objectsrequired
idstringrequired
Fansquare user id, referenced by assigned_user_id and attribution.user_id.
usernamestring | nullrequired
Display name.
rolestring | nullrequired
Base role of the member: owner, admin (also the Associate and the custom roles built on Admin), or chatter (the custom roles built on Chatter).
Valueschatteradminowner

curl 'https://api.fansquare.so/v1/employees' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
      "username": "sam_chat",
      "role": "chatter"
    }
  ]
}