User Groups

Get user group

Gets specific user group details

get/api/user-groups/v1/{user_group_id}

Request

Base URL
https://example.piwik.pro
Auth
OAuth 2
Client credentials
Token URL/auth/token
TypeScript
https://skmtc.dev/piwik/apis/web-api/docs/api/user-groups/v1/:user_group_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

user_group_idstring uuid required

UUIDv4 identifier of given user group

Response

OK

Example response

{
  "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.