users
Retrieve one or more User objects, with filters
Retrieve a list of users. You can filter the list by providing query parameters. Only users that you have access to will be returned, which in practice means they are in the same organization.
The response will be a list of user objects.
On the command line:
blind users list
get/api/users/
Request
- Base URLhttps://docs.blindinsight.io (the document declares no server; this is the origin it was published from)
- Auth
- API key in cookie sessionid
- or HTTP basic
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
date_joinedstring date-time
emailstring[]
first_namestring
First name (optional)
idstring
is_activeboolean
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_staffboolean
Designates whether the user can log into this admin site.
is_superuserboolean
Designates that this user has all permissions without explicitly assigning them.
last_loginstring date-time
last_namestring
Last name (optional)
limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
Response
Changes
No recorded changes to this operation across all 1 revision of this API.