v1
latestOpenAPI 3.0.02026-07-175652103.9 KBgroup
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
get/api/groups
Query parameters
currentinteger required
pageSizeinteger required