PIpiwik
User Groups

List user groups

Lists user groups

get/api/user-groups/v1

Request

Query parameters

searchstring

Search phrase - search for user group name, ID or external ID

sort'name' | 'created_at' | 'updated_at' | '-name' | '-created_at' | '-updated_at'

Sort field - can be reversed by adding dash before field name e.g (-name)

limitinteger

Limits the number of returned user groups in response

offsetinteger

Sets offset for list of items

Response

OK

Example response

{
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "6edb1e3c-4c43-4760-ab76-682ad83146be",
      "attributes": {
        "name": "Managers",
        "external_id": "external group id"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.