group

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

Response

msgstring required
totalinteger required

Changes

Changed in 2 of the 11 revisions of this API.24

  • 1b51dd9ab58f12See the full diff
    • the data response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • api tag group added

      api-tag-added

    • api tag todo removed

      api-tag-removed

  • fafd43b82c7812See the full diff
    • the data response's property type/format changed from array/ to string/ for status 200

      response-property-type-changed

    • api tag todo added

      api-tag-added

    • api tag group removed

      api-tag-removed

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog