PIpiwik
Users

Get users list

get/api/users/v2

Request

Query parameters

offsetinteger

Sets offset for list of items

limitinteger

Limits the number of returned items

search_querystring

(deprecated) Use search param instead

sort'email' | 'addedAt' | 'role' | '-email' | '-addedAt' | '-role'

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

searchstring

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

Response

OK

Example response

{
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "985ed9d7-b652-47b8-b9cf-c17d62735261",
      "type": "ppms/user",
      "attributes": {
        "email": "john@doe.com",
        "role": "USER",
        "organization": "organization_name",
        "addedAt": "2018-06-25T07:28:52+01:00",
        "language": "en-US"
      }
    }
  ]
}

Changes

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