API Explorer: /workspaces/{workspaceId}/users

To return a list of the workspace users, a workspaceId is required. The sample code returns a list of workspace users within workspaceId of 123456. Use the actual ID value for the workspace to return the list of the workspace users in your workspace.

curl 'https://a.blazemeter.com/api/v4/workspaces/123456/users' \
    --user 'api_key_id:api_key_secret'

Parameters

• roles array

  The roles you are wanting to get the list of workspace users for. Uses the following format: roles[]=${role}. These values can be any of the following:
  tester - Workspace tester role
  manager - Workspace manager role
  viewer - Workspace viewer role

• excludeRoles array

  The roles you are wanting to exclude from the list of account users. Uses the following format: excludeRoles[]=${role}. These values can be any of the following:
  tester - Workspace tester role
  manager - Workspace manager role
  viewer - Workspace viewer role

• enabled boolean

  Denotes if you are wanting to get a list of account users that are enabled (if true) or disabled (if false)

• textFilter string

  Filters the returned account user list to any account user emails that match the given string

Also see: Pagination

Attributes

• idinteger

  read-only

  The userId of the user

• emailstring

  read-only

  The email address of the user

• displayNamestring

  read-only

  The display name of the user

• firstNamestring

  read-only

  The first name of the user

• lastNamestring

  read-only

  The last name of the user

• logininteger

  read-only

  The timestamp for when the user last logged in

• accessinteger

  read-only

  The timestamp for when the user last accessed the workspace

• rolesarray

  An array of workspace roles that will be assigned to the user. Only ONE role should be assigned for any user. The following are the available roles:
  tester - Workspace tester role
  manager - Workspace manager role
  viewer - Workspace viewer role

• enabledboolean

  Denotes if the user is enabled in the workspace or not

• lastAccessinteger

  read-only

  The timestamp for when the user last accessed the workspace

{
    "limit": 10,
    "skip": 0,
    "total": 2,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": 123456,
            "email": "adminUser@myDomain.com",
            "displayName": "Admin User",
            "firstName": "Admin",
            "lastName": "User",
            "login": 1573488679,
            "access": 1573501903,
            "roles": [
                "manager"
            ],
            "enabled": true,
            "lastAccess": 1573501903
        },
        {
            "id": 234567,
            "email": "standardUser@myDomain.com",
            "displayName": "Standard User",
            "firstName": "Standard",
            "lastName": "User",
            "login": 1506347921,
            "access": 1516906397,
            "roles": [
                "tester"
            ],
            "enabled": false,
            "lastAccess": 1516906397,
            "type": "workspace"
        }
    ],
    "request_id": "5dc9bdef0a561"
}