sdk.user.list()

elements.sdk.api.user

List users by email.

Returns the details of users matching the specified email address. The specified user must belong to the same department as the requesting user, otherwise an error is thrown.

Parameters

  • email (str) - The email address to search for

Returns

List[User] - List of matching user objects

Example(s)

# List users by email
users = await sdk.user.list(email="[email protected]")

# Output (List[User])
[
    id: "user-uuid-here"
    name: "John Doe"
    email: "[email protected]"
    user_collection_id: "department-uuid"
]