| Field | Type | Required | Description | Example |
|---|---|---|---|---|
pending |
Optional[bool] | ➖ | Whether to return pending users. Default: false (all users) |
false |
ids |
List[str] | ➖ | A list of up to 100 user IDs. When provided, other parameters are ignored. | |
emails |
List[str] | ➖ | A list of up to 100 user Emails. When provided, other parameters are ignored. | |
prefix |
Optional[str] | ➖ | Returns users where the name begins with the specified case-insensitive string. | john |
sub_account_id |
Optional[str] | ➖ | Only returns users who have access to the specified account. | |
last_login |
Optional[bool] | ➖ | Specifies a date range for last login. | |
from_ |
datetime | ➖ | All last logins after this date, given in the format: yyyy-mm-dd. |
2023-01-01 00:00:00 +0000 UTC |
to |
datetime | ➖ | All last logins before this date, given in the format: yyyy-mm-dd. |
2024-12-31 00:00:00 +0000 UTC |
union_type |
Optional[models.UnionType] | ➖ | Whether to return users who last logged in within the specified date range (include) or those who didn't last log in within the range (exclude). Possible values: include, exclude. Default: include. |
|
sort_order |
Optional[models.QueryParamSortOrder] | ➖ | Control the order of returned users. Possible values: desc (default), asc. |
|
sort_by |
Optional[models.QueryParamSortBy] | ➖ | N/A | |
page |
Optional[int] | ➖ | N/A | |
page_size |
Optional[int] | ➖ | N/A |