/users

get https://develop.snipeitapp.com/api/v1/users

List users

time	status	user agent
Retrieving recent requests…

Loading…

By default, if just pass the search field, Snipe-IT will try to do a fuzzy search against many fields, which is useful in some cases and less so in others. As of v4.9.4, you can now also pass email and username to the search API endpoint and it will look for exact matches to those fields.

Query Params

string

String to search on

limit

int32

Defaults to 50

Number of records to return

offset

int32

Defaults to 0

Offset to use when retrieving results (useful in pagination)

sort

string

Defaults to created_at

Field to order by

order

string

Defaults to desc

Sort order (asc or desc)

first_name

string

last_name

string

username

string

employee_num

string

state

string

zip

string

country

string

group_id

int32

department_id

int32

company_id

int32

location_id

int32

deleted

boolean

Defaults to false

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

all

boolean

Defaults to false

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

ldap_import

boolean

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

assets_count

int32

Number of checked out assets

licenses_count

int32

Number of checked out licenses

accessories_count

int32

Number of checked out accessories

consumables_count

int32

Number of checked out consumables

remote

boolean

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

vip

int32

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

start_date

date

end_date

date

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://develop.snipeitapp.com/api/v1/users?limit=50&offset=0&sort=created_at&order=desc&deleted=false&all=false' \
3
     --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiZTU2MDc0MjVmYjM5YTEwYjFjNTZlZTAxMTBmZDk4ZjQ0ZjVjODMzYjcxZWVhYjZlNDk1NGMwOThlY2YzMzU2MDY4Mzg4MmFhMDMzOTAzNzciLCJpYXQiOjE2MzI4NjU5MTgsIm5iZiI6MTYzMjg2NTkxOCwiZXhwIjoyMjY0MDIxNTE4LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.LgGVzyH67IRhXvccHd4j2Dn6TDuIuQTBoo30_wD9jPehy8v_h0xBmE1-dOUBRJyeJOI8B4gwPeALsWaudpGj9Lb5qWAtKV7eYtH9IYQKoLF_iHgOGXnAUcNwID6zBU_YyLNSI6gp8zjutLJias33CBLsHy5ZRNpxVibVrZouJ_HjYuIYbtZyLus-KFFeibtZoPiTWOeHhQFD37MR6ifx4dBqT37fN-xDS99mONtrkAplEIou5aSO1oZ4IlJIPCUyA1lixPgpn1YU7PxiBDZp1teeugD0WEmrAqxRS2I0bH4qPsuTsrVXS_lo87Sf5LBGLW7lGHKqyYH6J47OZOM0K-SrxLKtE1ww8jyLBgnnxH0lJHRLCBiwUnL5ZGTUmiOysUA-wSJ6s78o8Pc-ec6bpBvAlelHdiQ-wslE7gzEJDptbejFg-75b_CEwgJYh7J2D18ul6Qu5EFCUEgt033mm04dgVk0isWTDt6EW5ZvTo5Qhr1LY0YnEIXCTqIRN-BSQjL55sZaCrtwR_21bnBGgniyI5MRDYblFawVmFKroeClCpSjBo9vi66akdD5hjpvx67RL3r33BZQhEXmPifUPNH5wP_U-IHGFUD99TJk2c1awF0RASveZRLSunbJb1x6hGAVUaIvQV4r2quWzXqYyKLph9kGTyJYrb6iJtH5smE' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400