latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

users

Lists all Users

You need tenants.user.list_all permission to access this resource

get/users

Query parameters

page[size]integer

Amount of items per page

page[number]integer

Number of page you want to display

issstring

Users must have OpenId identity equal to this value. Can't be used with "email" parameter

substring

Users must have OpenId subject equal to this value. Can't be used with "email" parameter

emailstring

Users must have email equal to this value

Response

OK

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/users/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "test@example.com",
        "company": "My Company",
        "registered": "2017-10-02T12:18:06.274Z",
        "last_login": "2018-03-15T16:53:57.696Z"
      }
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}