Users
Get a list of users
get
/users
Authorizations
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
404
500
Get a user by its ID
get
/users/{id}
Authorizations
Path parameters
idstringrequired
The ID of the user to fetch.
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
404
500
Update a user
patch
/users/{id}
Authorizations
Path parameters
idstringrequired
The ID of the user to update.
Body
role_idstring
The role_id of the user.
statusstring
The new user status for the user. Can be one of active
, away
, or out_of_office
.
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
404
500
Search for users by a given filter
Currently, the following fields are filterable for users:
post
/users/search
Authorizations
Body
cursorstring
The cursor to use for pagination.
filterobjectrequired
limitinteger · int64
The number of users to fetch. Defaults to 100. Must be greater than 0 and less than 1000.
Responses
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
404
500
Last updated
Was this helpful?