Autocomplete User

Prev Next
Get
/api/v1/users.autocomplete

List the users whose names match a given pattern.

Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
selector
objectRequired

Filter the response with the parameters.

Example{ "exceptions": [ "john.doe" ], "conditions": { "status": "offline" }, "term": "user", "$or": [ { "type": "user" }, { "roles": [ "bot" ] } ] }
Responses
200
400
401
Collapse all
object
items
Array of object
object
_id
string
username
string
status
string
name
string
nickname
string
success
boolean