User Groups

Get user group members

Gets user group members

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

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/users/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

Query parameters

searchstring

Search phrase for searching users by email or user id

sort'email' | '-email'

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

limitstring

Limits the number of returned items

offsetinteger

Sets offset for list of items

Response

Example response

{
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "6edb1e3c-4c43-4760-ab76-682ad83146be",
      "attributes": {
        "email": "example@example.com"
      }
    }
  ]
}

Changes

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