GET groups

GET
/groups

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Query Parameters

MembershipYear?integer
Formatint32
IncludeInactive?boolean

Indicates whether to include inactive groups in the retrieved group data. If set to true, both active and inactive groups will be included in the response; if set to false, only active groups will be included. This field allows for filtering group data based on their active status, enabling the retrieval of groups that are currently active or all groups regardless of their active status based on the client's needs.

Response Body

OK

application/json
  1. response
[index: integer]?

Represents the response DTO for a group, containing all relevant information about the group, including its properties and any associated data. The GroupResponseDTO is used to transfer comprehensive group data from the server to the client when retrieving group information, allowing for a complete representation of the group's details in the response payload. The GroupResponseDTO can include properties such as the group's unique identifier, name, active status, type, and any associated group picture information, providing a comprehensive view of the group data for the client application.

curl -X GET 'https://example.com/groups'
[  {    "id": 0,    "name": "string",    "active": true,    "type": "Committee",    "glAccountId": "string",    "costCenterId": "string",    "costUnitId": "string",    "groupPicturePath": "string"  }]