GET /users
snipeit_gen_usersQuery Snipe-IT users with filters, search, sorting, and pagination. Retrieve active, deleted, or all users by department, email, name, and more.
Instructions
GET /users: List users. Generated from Snipe-IT OpenAPI operation users.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all | No | Set this to "true" if you want both deleted and active users | |
| vip | No | Whether or not the user is marked as a VIP (1 or 0 for true or false, respectively) | |
| zip | No | ||
| sort | No | Field to order by | |
| No | |||
| limit | No | Number of records to return | |
| order | No | Sort order (asc or desc) | |
| state | No | ||
| filter | No | Key value pair of the field you want to search on and the value, for example: `{"email":"info@example.com"}"` | |
| offset | No | Offset to use when retrieving results (useful in pagination) | |
| remote | No | Whether the user is marked as a remote worker or not (should be 0 or 1) | |
| search | No | String to search on | |
| country | No | ||
| deleted | No | Set this to "true" if you want to return only deleted users | |
| end_date | No | ||
| group_id | No | ||
| username | No | ||
| last_name | No | ||
| company_id | No | ||
| first_name | No | ||
| start_date | No | ||
| ldap_import | No | Whether the user was imported/synched with LDAP - should be 0 or 1 | |
| location_id | No | ||
| assets_count | No | Number of checked out assets | |
| employee_num | No | ||
| department_id | No | ||
| licenses_count | No | Number of checked out licenses | |
| accessories_count | No | Number of checked out accessories | |
| consumables_count | No | Number of checked out consumables |