List users

get/users

Request

  • Base URL
    https://develop.snipeitapp.com/api/v1
  • URL
    https://develop.snipeitapp.com/api/v1/users
  • Auth
    none required

Query parameters

searchstring

String to search on

limitinteger

Number of records to return

offsetinteger

Offset to use when retrieving results (useful in pagination)

sortstring

Field to order by

orderstring

Sort order (asc or desc)

first_namestring
last_namestring
usernamestring
emailstring
employee_numstring
statestring
zipstring
countrystring
group_idinteger
department_idinteger
company_idinteger
location_idinteger
deletedboolean

Set this to "true" if you want to return only deleted users

allboolean

Set this to "true" if you want both deleted and active users

ldap_importboolean

Whether the user was imported/synched with LDAP - should be 0 or 1

assets_countinteger

Number of checked out assets

licenses_countinteger

Number of checked out licenses

accessories_countinteger

Number of checked out accessories

consumables_countinteger

Number of checked out consumables

remoteboolean

Whether the user is marked as a remote worker or not (should be 0 or 1)

vipboolean

Whether or not the user is marked as a VIP (1 or 0 for true or false, respectively)

start_datestring date
end_datestring date
filterstring json

Key value pair of the field you want to search on and the value, for example: {"email":"info@example.com"}"

Response

200

object required

Changes