Team users endpoint

Team users documentation

Fetch all team users

team_users(team_id[, params = None])

param team_id:

ID of the team

type team_id:

str or int

param dict params:

(optional) pagination options

return:

Collection of team users

Example:

users = client.team_users(7890, {
    "page": 2,
    "limit": 4
})
users.items[0].user_id # => 12345

Fetch a team user

team_user(team_id, team_user_id)

Parameters:

• team_id (str or int) – ID of the team

• team_user_id (str or int) – ID of the team user to fetch

Returns:

Team user model

Example:

user = client.team_user(7890, 12345)
user.email # => "elf@lorien.com"
user.fullname # => "Mr. Elf"

Update a team user

update_team_user(team_id, team_user_id[, params = None])

Parameters:

• team_id (str or int) – ID of the team

• team_user_id (str or int) – ID of the team user to update

• params (dict) – (optional) Team user parameters

Returns:

Team user model

Example:

user = client.update_team_user(7890, 12345, {"role": "admin"})
user.role # => "admin"

Delete a team user

delete_team_user(team_id, team_user_id)

Parameters:

• team_id (str or int) – ID of the team

• team_user_id (str or int) – ID of the team user to delete

Returns:

Dict with the team ID and team_user_deleted set to True

Example:

client.delete_team_user(7890, 12345)