List users
list_usersRead-only
List the portal's users (id, login, name, email, user type, status, registration, last login), paginated. Filter by keyword (name/login/email), exact email or login, status, branch, group, last-updated range or a custom field value. GET /api/v2/users.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (default 1). | |
| No | Exact email address. | ||
| login | No | Exact username (login). | |
| status | No | Only active or inactive users. | |
| keyword | No | Search across name, surname, login and email. | |
| group_id | No | Only users in this group. | |
| branch_id | No | Only users in this branch. | |
| page_size | No | Items per page, 1-100 (TalentLMS default 10). | |
| updated_to | No | Users updated on or before this ISO 8601 date-time. | |
| updated_from | No | Users updated on or after this ISO 8601 date-time, e.g. 2025-01-01T00:00:00. | |
| custom_field_value | No | Users with this value in one of their custom user fields. |