latestSwagger 2.02026-08-1024042.7 KB

a3ea128a9743

Users

List users

get/api/v1/users

Query parameters

filter[email]string

Case-sensitive

filter[employee_number]string

Case-sensitive. Since employee_number is unique across all users, only one user will be returned.

filter[first_name]string

Case-sensitive e.g. searching for 'Jon' is NOT the same as searching for 'jon'.

filter[last_name]string

Case-sensitive e.g. searching for 'Snow' is NOT the same as searching for 'snow'.

filter[manager_user_id]integer

The user ID of their manager

filter[must_reset_password]boolean

filter[form_name]string

Case-sensitive. The name of their Form in the organization.

filter[process_name]string

Case-sensitive. The name of the process associated with their primary review.

filter[roles]string

The roles the user has in the software e.g. admin, restricted_admin, manager

filter[terminated]boolean

By default, terminated users will not be included. To select terminated users only, set this to true.

filter[username]string

Case-sensitive. Since username is unique across all users, only one user may be returned.

filter[current_login_at_min]string

Format is YYYY-MM-DD

filter[current_login_at_max]string

Format is YYYY-MM-DD

filter[hire_date_min]string

Format is YYYY-MM-DD

filter[hire_date_max]string

Format is YYYY-MM-DD

filter[review_archive_date_min]string

The due date of their primary review. Format is YYYY-MM-DD.

filter[review_archive_date_max]string

The due date of their primary review. Format is YYYY-MM-DD.

filter[terminated_date_min]string

Format is YYYY-MM-DD

filter[terminated_date_max]string

Format is YYYY-MM-DD

filter[welcome_email_sent_at_min]string

Format is YYYY-MM-DD

filter[welcome_email_sent_at_max]string

Format is YYYY-MM-DD

sortstring

Sort fields must be given in lowercase. Valid sort fields include: id, employee_number, username, first_name, last_name, email, hire_date, current_login_at, must_reset_password, welcome_email_sent_at, terminated, terminated_date, manager_user_id, form_name, process_name, review_archive_date, and roles

includestring

value can be 'groups' to include user group information in results

page[number]integer

page[size]integer

Must be less than or equal to 100

Headers

Content-Typestring required

Response

Success

linksobject