[GET] /api/groups/my

[GET] /api/groups/my

/api/groups/my

Description

This method returns details of the groups to which the calling user belongs to.

The list of all enaio groups is cached internally and will be refreshed automatically every 10 minutes.

The list can also be refreshed by the optional request parameter refresh.

The optional request parameter includeUsers can be used to include the users of each group in the response.

Request Method

GET

Optional Request Parameters

  • includeUsers (boolean): Include the users of each group in the result.

  • refresh=true: The cache will be invalidated, all data is reloaded from the enaio server and cached again.

Response Format

application/json

Minimum Version

1.0.0

Request Examples

/api/groups/my
/api/groups/my?refresh=true
/api/groups/my?refresh=true&includeUsers=true

Result Examples

Groups only:

[ { "id": 0, "osguid": "0A87FA835872482393F541580BA947AD", "name": "STANDARD", "description": "The standard group" }, { "id": 1, "osguid": "E1DF4F0FFE3540DBB1615F38CD769AA1", "name": "MARKETING", "description": "The marketing group" } ]

Groups with users:

[ { "id": 0, "osguid": "0A87FA835872482393F541580BA947AD", "name": "STANDARD", "description": "The standard group", "users": [ { "id": 1, "name": "USER1", "fullName": "User 1" }, { "id": 2, "name": "USER2", "fullName": "User 2" } ] } ]