Skip to main content

users/search (GET)


Find a subset of users.

  • REST Method: GET
  • Method Access: public

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)
limit int? Maximum number of items to retrieve. Actual maximum is capped by site setting.
format string? Output format: autocomplete,default,verbose
groupid uint? Search for users in a specific group
seated bool? Search for users with or without seats
active bool? Search for users by their active status
authprovider int? Return users belonging to given authentication service id
fullname string? Search for users full name starting with supplied text
username string? Search for users name starting with supplied text
email string? Search for users by name and email or part of a name and email

Return Codes

Name Value Description
OK 200 The request completed successfully
Forbidden 403 Read access is required
  • Was this article helpful?