get /groups
Gets the groups.
Returns the list of groups.
Query parameters
- groupname (optional)
- The group name to use as a filter.
- enabled (optional)
- Indicates whether to retrieve the active groups (true) or inactive groups (false).
- offset (optional)
- The number of entries to skip. Default is 0.
- limit (optional)
- The maximum number of entries to return. Default is 50.
- sort (optional)
A comma separated list of fields to use for sorting the entries. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.
Usage example: /groups?sort=+name,-created
Return type
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : "00000000-0000-0000-0000-000000000000",
"enabled" : true
}, {
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : "00000000-0000-0000-0000-000000000000",
"enabled" : true
} ]
}
}
Responses
- 200
- Success. A paginated list of groups is returned.
- 400
- The query string is malformed.