get_users
Read-onlyIdempotent
Retrieve a paginated list of all school users, with optional filters by role, status, tags, registration date, and custom fields. Use to manage user data programmatically.
Instructions
🟢 READ-ONLY · Users · GET /v2/users
Get all users
Returns a list with all the users of the school. The users are in sorted order, with the most recently created user appearing first, and the list is paginated, with a default limit of 20 users per page. To refine the list of users, there are a number of query params outlined in the following section; In case more than one Query param is provided, then all of them will be applied (AND operator).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Filter by the page number. In case page number is higher than the maximum one, the results of last page will be returned | |
| role | No | Filter by user role | |
| tags | No | Filter by tags. For several tag values, a comma separated string can be provided. | |
| status | No | Filter by user status | |
| cf_$field_name | No | Filter by custom field. All custom fields start with the cf_ prefix; the "$field_name" part should be replaced by the name of the corresponding custom field. Also, it is possible to use more than one custom fields as filters, using the aforementioned convention. | |
| items_per_page | No | Filter by the items per page number | |
| include_suspended | No | Filter by include_suspended flag. The default value is false. | |
| registration_after | No | Filter by registration after the given datetime (expected in UNIX timestamp format) | |
| registration_before | No | Filter by registration before the given datetime (expected in UNIX timestamp format) |