user-query-params.md

User Query Params

Param	Accepts	Description
addOrderBy	`string	array
addSelect	`string	array
admin	bool	Whether to only return users that are admins
ancestorDist	`int	null`
ancestorOf	`int	ElementInterface
andWhere	`string	array`
archived	bool	Whether to return only archived elements
asArray	bool	Whether to return each element as an array
can	`string	int
client	bool	Whether to only return the client user
contentTable	`string	null`
customFields	`FieldInterface[]	null`
dateCreated	mixed	When the resulting elements must have been created
dateUpdated	mixed	When the resulting elements must have been last updated
descendantDist	`int	null`
descendantOf	`int	ElementInterface
elementType	`string	null`
email	`string	string[]
enabledForSite	bool	Whether the elements must be enabled for the chosen site
firstName	`string	string[]
fixedOrder	bool	Whether results should be returned in the order specified by id
group	`string	string[]
groupId	`int	int[]
id	`int	int[]
indexBy	`string	callable`
lastLoginDate	mixed	The date that the resulting entries must have last logged in
lastName	`string	string[]
level	`int	null`
limit	integer	Maximum number of records to be returned
nextSiblingOf	`int	ElementInterface
offset	integer	Zero-based offset from where the records are to be returned
orWhere	`string	array`
orderBy	array	How to sort the query results
positionedAfter	`int	ElementInterface
positionedBefore	`int	ElementInterface
prevSiblingOf	`int	ElementInterface
ref	`string	string[]
relatedTo	`int	array
search	`string	array
select	array	The columns being selected
siblingOf	`int	ElementInterface
site	`string	Site`
siteId	`int	null`
slug	`string	string[]
status	`string	string[]
structureId	`int	false
title	`string	string[]
uid	`string	string[]
uri	`string	string[]
username	`string	string[]
where	`string	array`
with	`string	array
withPassword	bool	Whether the users' passwords should be fetched