KOkontainer
Usergroups

Returns a list of usergroups

## Retrieve Usergroups
Endpoint for retrieving a collection of Usergroups.
get/user-groups

Request

Query parameters

page[size]integer

Define the per page size. (defaults to 100, limit is 500) Example: page[size]=10

page[number]integer

Define the page number. (defaults to 1) Example: page[number]=1

Response

success

Example response

{
  "data": [
    {
      "type": "user_group",
      "id": "55211",
      "attributes": {
        "name": "Advertisement",
        "note": "This group contains only third-party advertisement users.",
        "active": true,
        "show_brand_section": 1,
        "hide_menu_by_default": true
      }
    }
  ],
  "links": {
    "first": "https://kontainer.test/jsonapi/v2/user-groups?page=1",
    "last": "https://kontainer.test/jsonapi/v2/user-groups?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://kontainer.test/jsonapi/v2/user-groups?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "path": "https://kontainer.test/jsonapi/v2/user-groups",
    "per_page": 100,
    "to": 10,
    "total": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.