Get Group Count

Queries for groups using a list of parameters and retrieves the count.

Method

GET /group/count

Parameters

Query Parameters

Name Description
id Filter by the id of the group.
idIn Filter by a comma-separated list of group ids.
name Filter by the name of the group.
nameLike Filter by the name that the parameter is a substring of.
type Filter by the type of the group.
member Only retrieve groups where the given user id is a member of.
memberOfTenant Only retrieve groups which are members of the given tenant.

Result

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

Name Value Description
count Number The number of matching groups.

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 /group/count?name=Sales

Response

Status 200.

{"count": 1}

On this Page: