GetUserCount

Get User Count

Allows to an user count based on filters.

Request

URL: /v1/users/count

Method: GET

Path Parameters: None

Query Parameters:

Parameter	Type	Description	Requirement Type
ids	string list	Comma-separated list of user UUID's for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
roles	string list	Comma-separated list of user roles for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
genres	string list	Comma-separated list of user genres for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
olderThan	string	ISO-8601 formated oldest (maximum) timestamp to filter-out results. If missing, defaults to no filtering out.	Optional
newerThan	string	ISO-8601 formated newest (minimum) timestamp to filter-out results. If missing, defaults to no filtering out.	Optional

Headers:

Accept: application/json

Authorization: Bearer {accessToken}

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field	Type	Description	Condition
count	long	User count.	Always

Content example:

{
    "count": 300
}

❌ Error Responses

1. Unauthorized

Code: 401 UNAUTHORIZED

Condition: If {accessToken} is invalid or expired.

2. Unprocessable Entity

Code: 422 UNPROCESSABLE ENTITY

Condition: If any of the UUID query parameters is malformed.

Headers:

Content-Type: application/json

Content example:

{
    "code": 422,
    "description": "Unprocessable Entity",
    "cause": "Invalid UUID string: 123456789"
}

See Also

Post User (Add New User)

Patch User (Update User)

Get User (Get User)

Get Users

Delete User

Put User Password (Reset Password)