Get Users Count

Query for users using a list of parameters and retrieves the count.

Method

GET /user/count

Parameters

Query Parameters

Name Description
id Filter by the id of the user.
firstName Filter by the firstname of the user.
firstNameLike Filter by the firstname that the parameter is a substring of.
lastName Filter by the lastname of the user.
lastNameLike Filter by the lastname that the parameter is a substring of.
email Filter by the email of the user.
emailLike Filter by the email that the parameter is a substring of.
memberOfGroup Filter for users which are members of a group.

Result

A JSON object that contains the count as the only property.

Name Value Description
count Number The number of matching users.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy is specified. See the Introduction for the error response format.

Example

Request

GET /user/count?firstName=John

Response

Status 200.

{"count": 2}

On this Page: