v1

latestOpenAPI 3.1.02026-07-241280174.1 KB

Workplace Users

Get all users of a workplace

get/v3/workplace/users

Query parameters

settingsboolean

If true, the api will return more information if users have e.g. SAML enabled and/or Multi Factor Auth enabled

pageinteger

The page of users to fetch

Response

200

pageinteger
successboolean

Example response

{
  "workplace_users": [
    {
      "id": "45786c9a-8c97-4f5b-a35b-ce941796502b",
      "access": "owner",
      "created_at": "2020-09-01T23:57:27.052Z",
      "user": {
        "email": "test@example.com",
        "name": "Adam Smith",
        "username": "adam_smith",
        "profile_image_url": "https://www.gravatar.com/avatar/12345678?s=500&d=retro",
        "thirdparty_sso_enabled": true
      }
    }
  ],
  "page": 1,
  "success": true
}