Fetching User Information

The GET /v3/user endpoint is used to fetch user information.

GET /v3/user?pageNumber=1&pageSize=10&sortBy=id&sortDirection=descending
Authorization: Basic ${ base64(apiKey + ':' + secretKey) }

Parameter	Required	Description
pageNumber	No	Which page to fetch. Defaults to 1.
pageSize	No	The size of the page. Can be no more than 100. Defaults to 10.
sortBy	No	Which property to sort the results by. Can be one of: 'id', 'createdAt', 'lastLoggedInAt'.
sortDirection	No	Can be one of: 'ascending', 'descending'. Defaults to 'ascending'.
isAdmin	No	Filter users based on whether they are admins or not.

Response example:

HTTP/2.0 200 OK

{
  "data": [
    {
      "ssn": "YYYYMMDDXXXX",
      "country": "SWEDEN",
      "authType": "EID",
      "email": "firstname.lastname@example.com",
      "createdAt": "2020-01-01 00:00:00",
      "lastLoggedInAt": "2020-01-01 00:00:00",
      "isAdmin": false,
      "services": [
        {
          "type": "TELEID",
          "countries": ["SWEDEN"]
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1
}