Get User 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. |
| idIn | Filter by a comma-separated list of user ids. |
| firstName | Filter by the first name of the user. |
| firstNameLike | Filter by the first name that the parameter is a substring of. |
| lastName | Filter by the last name of the user. |
| lastNameLike | Filter by the last name that the parameter is a substring of. |
| 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 the given group. |
| memberOfTenant | Filter for users which are members of the given tenant. |
| potentialStarter | Only select Users that are potential starter for the given process definition. |
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}