Get the List of Groups
This function is an API endpoint that allows an authenticated admin to retrieve a paginated list of groups. It is tagged with "group" for OpenAPI documentation.
Parameters
-
current: The current page number.
-
pageSize: The number of groups per page.
Returns
If successful, this function returns a Json<GroupsResponse> object, which includes a success message, the total number of groups, and the list of groups. <br> If no groups are found, this function returns a status::NotFound error. <br>
Errors
This function will return an error if the system is in maintenance mode, or if no groups are found.
Example
GET /api/groups?current=1&pageSize=10
Query parameters
Response
Changes
Changed in 2 of the 11 revisions of this API.24
- ▲
the
dataresponse's property type/format changed fromstring/toarray/for status200response-property-type-changed
- ○
api tag
groupaddedapi-tag-added
- ○
api tag
todoremovedapi-tag-removed
- ▲
- ▲
the
dataresponse's property type/format changed fromarray/tostring/for status200response-property-type-changed
- ○
api tag
todoaddedapi-tag-added
- ○
api tag
groupremovedapi-tag-removed
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲