Getting started

Authentication
Make a first API call
Rate limits

Resources

API call definition
Metrics & dimensions
Profile attributes
Tag Manager

Web API

Access Control
Analytics
Apps
Audit Log
- Entry listget
Customer Data Platform
Container Settings
Meta sites
Modules
OAuth
- Issue OAuth Tokenpost
Tag Manager
Tracker
Tracker Settings
User Groups
Users

Getting started

Authentication
Make a first API call
Rate limits

Resources

API call definition
Metrics & dimensions
Profile attributes
Tag Manager

Web API

Access Control
Analytics
Apps
Audit Log
- Entry listget
Customer Data Platform
Container Settings
Meta sites
Modules
OAuth
- Issue OAuth Tokenpost
Tag Manager
Tracker
Tracker Settings
User Groups
Users

Get users list

get https://{account}.piwik.pro/api/users/v2

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Query Params

offset

integer

≥ 0

Defaults to 0

Sets offset for list of items

limit

integer

0 to 1000

Defaults to 10

Limits the number of returned items

search_query

string

(deprecated) Use search param instead

sort

string

Defaults to -addedAt

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

string

User search query. You can search by email or id.

Responses

Response body

object

meta

object

Metadata of a listing

total

integer

required

Total number of items

data

array of objects

data

object

uuid

Resource ID

type

string

PPAS user resource type

ppms/user

attributes

object

Response body

object

errors

array of objects

errors

object

status

string

required

the HTTP status code applicable to this problem, expressed as a string value

code

string

an application-specific error code, expressed as a string value

title

string

required

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization

detail

string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

source

object

an object containing references to the source of the error, optionally including any of the following members: [pointer, parameter]

Response body

object

errors

array of objects

errors

object

status

string

required

the HTTP status code applicable to this problem, expressed as a string value

code

string

an application-specific error code, expressed as a string value

title

string

required

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization

detail

string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized

source

object

an object containing references to the source of the error, optionally including any of the following members: [pointer, parameter]

Updated 5 days ago

Create user

Get details of an user

Did this page help you?

Language

Credentials

OAuth2

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.piwik.pro/api/users/v2?offset=0&limit=10&sort=-addedAt' \
3
     --header 'accept: application/vnd.api+json'


xxxxxxxxxx
18
 
1
{
2
  "meta": {
3
    "total": 1
4
  },
5
  "data": [
6
    {
7
      "id": "985ed9d7-b652-47b8-b9cf-c17d62735261",
8
      "type": "ppms/user",
9
      "attributes": {
10
        "email": "john@doe.com",
11
        "role": "USER",
12
        "organization": "organization_name",
13
        "addedAt": "2018-06-25T07:28:52+01:00",
14
        "language": "en-US"
15
      }
16
    }
17
  ]
18
}

Updated 5 days ago

Create user

Get details of an user

Did this page help you?

Getting started
Authentication
Make a first API call
Rate limits

Resources
API call definition
Metrics & dimensions
Exporter
SharePoint
Google Search Console
Google Ads
Piwik PRO
Profile attributes
Tag Manager
Asynchronous operations
Built-in variables
Tags

Web API
Access Control
Permissionsget
Permission setpost
Set user group permission for a given meta sitepost
Set user permission for a given meta sitepost
Set user group permission for a given apppost
Set user permission for a given apppost
User groups permissions for a given meta siteget
Users permissions for a given meta siteget
User groups permissions for a given appget
Users permissions for a given appget
Global actionsget
Users with granted actionget
Meta sites with granted actionget
Apps with granted actionget
Entity actionsget
Analytics
List System Annotationsget
Delete user annotationdelete
Update user annotationpatch
Get user annotationget
List user annotationsget
Create user annotationpost
Update product custom dimensionput
Get product custom dimensionget
List product custom dimensionsget
Create product custom dimensionpost
Get custom dimension slotsget
Update custom dimensionput
Get custom dimensionget
List custom dimensionsget
Create custom dimensionpost
Delete goaldelete
Update goalput
Get goalget
List goalsget
Create goalpost
Fetch Real-time eventspost
Fetch eventspost
Fetch sessionspost
Execute Real-time querypost
Execute querypost
Apps
Apps permission for user groupget
App permissionsget
App editpatch
App deletedelete
App detailsget
App addpost
Apps listget
Audit Log
Entry listget
Customer Data Platform
Test webhookget
Activate webhook importpost
Update webhook importput
Fetch webhook importget
Create webhook importpost
List webhook importsget
Data webhook import PUT requestput
Data webhook import POST requestpost
Data webhook import GET requestget
Create or update profile attributespost
Get profile by identifierget
Fetch audiences the profile belongs toget
Fetch activation usage statisticsget
Fetch webhook import requests statisticsget
Fetch webhook import requestsget
Fetch last webhook import requestsget
List profiles belonging to given audienceget
List profiles belonging to given audience.get
Count profiles in audienceget
Fetch details of activation logget
Fetch activation statisticsget
Fetch activation logsget
Fetch last activation logsget
Fetch conversion actionsget
Fetch user listsget
Fetch customersget
List enum variantsget
Delete audiencedelete
Update audienceput
Fetch audienceget
List audiencesget
Create audiencepost
Update custom attributeput
Create custom attribute bulkpost
Create custom attributepost
List attributesget
Activate activationpost
Delete activationdelete
Update activationput
Fetch activationget
Create activationpost
List activationsget
Container Settings
Modify organization's container settingput
Fetch organization's container settingget
Modify organization's container settingspatch
Get list of organization's container settingsget
Get App's default container settingsget
Modify App's container settingput
Remove the App's container settingdelete
Get the App's container settingget
Modify App's container settingspatch
Get App's container settingsget
Get organization's opt-out codeget
Get App's installation codeget
Meta sites
Meta site integrityget
List apps & meta sitesget
List apps excluded from meta siteget
List apps in meta siteget
Remove apps from meta sitedelete
Add apps to meta sitepost
Delete meta sitedelete
Edit meta sitepatch
Get meta siteget
Add meta sitepost
List meta sitesget
Modules
Set modules access for a given userput
Modules access list for a given userget
Moduleget
Modules list for given userspost
Modules listget
OAuth
Issue OAuth Tokenpost
Tag Manager
Import version from filepost
Import versionpost
Publish version by idpost
Publish draft versionpost
Get export fileget
Create export filepost
Snapshot draft versionpost
Restore version by idpost
Restore published versionpost
Get published versionget
Get draft versionget
Get versionget
List of versionsget
Copy variablepost
Delete variabledelete
Edit variablepatch
Get variableget
Create variablepost
List of variablesget
Copy triggerpost
Delete triggerdelete
Edit triggerpatch
Get triggerget
List of tags for a given triggerget
Create triggerpost
List of triggersget
Copy tagpost
Delete tagdelete
Edit tagpatch
Get tagget
List of triggers for a given tagget
Create tagpost
Edit tags orderpatch
List of tagsget
Get operationget
Get list of changesget
Tracker
Tracking endpointpost
Tracking endpointget
Debuggerget
Logsget
Tracker Settings
Get tracker settings of an app by it's urlget
Delete given tracker setting of an appdelete
Edit tracker settings of an apppatch
Get tracker settings of an appget
Edit global tracker settingspatch
Get global tracker settingsget
Edit global, tracker related settings of appspatch
Get global, tracker related settings of appsget
User Groups
Set permission grouppost
Remove users from user groupdelete
Add users to user grouppost
Get users excluded from groupget
Get user group membersget
Delete user groupdelete
Edit user grouppatch
Get user groupget
Add user grouppost
List user groupsget
Users
Edit own accountpatch
Current user detailsget
Current user detailsget
Change my passwordpatch
Change user rolepatch
Edit userpatch
Delete userdelete
Get details of an userget
Get users listget
Create userpost
Invite userpost

Getting started
Authentication
Make a first API call
Rate limits

Resources
API call definition
Metrics & dimensions
Exporter
SharePoint
Google Search Console
Google Ads
Piwik PRO
Profile attributes
Tag Manager
Asynchronous operations
Built-in variables
Tags

Web API
Access Control
Permissionsget
Permission setpost
Set user group permission for a given meta sitepost
Set user permission for a given meta sitepost
Set user group permission for a given apppost
Set user permission for a given apppost
User groups permissions for a given meta siteget
Users permissions for a given meta siteget
User groups permissions for a given appget
Users permissions for a given appget
Global actionsget
Users with granted actionget
Meta sites with granted actionget
Apps with granted actionget
Entity actionsget
Analytics
List System Annotationsget
Delete user annotationdelete
Update user annotationpatch
Get user annotationget
List user annotationsget
Create user annotationpost
Update product custom dimensionput
Get product custom dimensionget
List product custom dimensionsget
Create product custom dimensionpost
Get custom dimension slotsget
Update custom dimensionput
Get custom dimensionget
List custom dimensionsget
Create custom dimensionpost
Delete goaldelete
Update goalput
Get goalget
List goalsget
Create goalpost
Fetch Real-time eventspost
Fetch eventspost
Fetch sessionspost
Execute Real-time querypost
Execute querypost
Apps
Apps permission for user groupget
App permissionsget
App editpatch
App deletedelete
App detailsget
App addpost
Apps listget
Audit Log
Entry listget
Customer Data Platform
Test webhookget
Activate webhook importpost
Update webhook importput
Fetch webhook importget
Create webhook importpost
List webhook importsget
Data webhook import PUT requestput
Data webhook import POST requestpost
Data webhook import GET requestget
Create or update profile attributespost
Get profile by identifierget
Fetch audiences the profile belongs toget
Fetch activation usage statisticsget
Fetch webhook import requests statisticsget
Fetch webhook import requestsget
Fetch last webhook import requestsget
List profiles belonging to given audienceget
List profiles belonging to given audience.get
Count profiles in audienceget
Fetch details of activation logget
Fetch activation statisticsget
Fetch activation logsget
Fetch last activation logsget
Fetch conversion actionsget
Fetch user listsget
Fetch customersget
List enum variantsget
Delete audiencedelete
Update audienceput
Fetch audienceget
List audiencesget
Create audiencepost
Update custom attributeput
Create custom attribute bulkpost
Create custom attributepost
List attributesget
Activate activationpost
Delete activationdelete
Update activationput
Fetch activationget
Create activationpost
List activationsget
Container Settings
Modify organization's container settingput
Fetch organization's container settingget
Modify organization's container settingspatch
Get list of organization's container settingsget
Get App's default container settingsget
Modify App's container settingput
Remove the App's container settingdelete
Get the App's container settingget
Modify App's container settingspatch
Get App's container settingsget
Get organization's opt-out codeget
Get App's installation codeget
Meta sites
Meta site integrityget
List apps & meta sitesget
List apps excluded from meta siteget
List apps in meta siteget
Remove apps from meta sitedelete
Add apps to meta sitepost
Delete meta sitedelete
Edit meta sitepatch
Get meta siteget
Add meta sitepost
List meta sitesget
Modules
Set modules access for a given userput
Modules access list for a given userget
Moduleget
Modules list for given userspost
Modules listget
OAuth
Issue OAuth Tokenpost
Tag Manager
Import version from filepost
Import versionpost
Publish version by idpost
Publish draft versionpost
Get export fileget
Create export filepost
Snapshot draft versionpost
Restore version by idpost
Restore published versionpost
Get published versionget
Get draft versionget
Get versionget
List of versionsget
Copy variablepost
Delete variabledelete
Edit variablepatch
Get variableget
Create variablepost
List of variablesget
Copy triggerpost
Delete triggerdelete
Edit triggerpatch
Get triggerget
List of tags for a given triggerget
Create triggerpost
List of triggersget
Copy tagpost
Delete tagdelete
Edit tagpatch
Get tagget
List of triggers for a given tagget
Create tagpost
Edit tags orderpatch
List of tagsget
Get operationget
Get list of changesget
Tracker
Tracking endpointpost
Tracking endpointget
Debuggerget
Logsget
Tracker Settings
Get tracker settings of an app by it's urlget
Delete given tracker setting of an appdelete
Edit tracker settings of an apppatch
Get tracker settings of an appget
Edit global tracker settingspatch
Get global tracker settingsget
Edit global, tracker related settings of appspatch
Get global, tracker related settings of appsget
User Groups
Set permission grouppost
Remove users from user groupdelete
Add users to user grouppost
Get users excluded from groupget
Get user group membersget
Delete user groupdelete
Edit user grouppatch
Get user groupget
Add user grouppost
List user groupsget
Users
Edit own accountpatch
Current user detailsget
Current user detailsget
Change my passwordpatch
Change user rolepatch
Edit userpatch
Delete userdelete
Get details of an userget
Get users listget
Create userpost
Invite userpost

200OK

400Bad Request

403Forbidden

Get the full experience

Analytics