Web API

List user groups

get
https://{account}.piwik.pro/api/user-groups/v1

Lists user groups

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string
enum
Defaults to name

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

Allowed:
integer
≤ 1000
Defaults to 10

Limits the number of returned user groups in response

integer
≥ 0
Defaults to 0

Sets offset for list of items

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

Updated 7 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 7 months ago