Documentation

api.users.fetch

Fetch all users for a given site, with optional filters. If you have a large number of users in your site, this call may not work due to timing out.

Arguments:

def api.users.fetch(
  training_id: <str> = None,
  training_name: <str> = None,
  usergroup_id: <str> = None,
  usergroup_name: <str> = None,
):

Returns list of dict users in the form:

[{
  'user_id': str,
  'email': str, # Primary user email
  'display_name': str,
}, ...]

Example:

users = api.users.fetch(usergroup_id="foo") # users = [ <dict> ]