You can get a list of users and their points by sending a GET request to the following URL: /gamification/points.
Permission to run the request: Account Owner, Account Administrators, Department Administrators, Publishers, or users with a custom role.
Department Administrators, Publishers, and users with a custom role can get a list of users belonging to departments they manage and their sub-departments.
Request Headers
Parameter | Description |
|---|---|
| X-Auth-Account-Url (required) | The base URL of the account, e.g. http://myaccount.ispringlearn.com |
| X-Auth-Email (required) | The login of Account Owner, Account Administrator, Department Administrator, Publisher or a user with a custom role. |
| X-Auth-Password (required) | The password of Account Owner, Account Administrator, Department Administrator, Publisher or a user with a custom role. |
After the request has been processed, the system returns the response with the 200 code. The response body contains the XML data regarding users and their points.
Response Codes
Code | Text | Description |
|---|---|---|
| 200 | Successful operation | The request has been successfully processed. |
| 400 | Bad Request | A request error. |
| 401 | Unauthorized | An authorization error. |
| 403 | Permission denied | The user doesn't have enough permissions to get a list of users. |
Sample Request
GET /gamification/points HTTP/1.1 Host: api-learn.ispringlearn.com X-Auth-Account-Url: https://myaccount.ispringlearn.com X-Auth-Email: email@email.com X-Auth-Password: password
Sample Response
HTTP/1.1 200 Successful operation Connection: close <?xml version="1.0" encoding="UTF-8"?> <response> <userPointsInfo> <userId>2c180ffc-8841-11e9-b68a-0242c0a85016</userId> <points>421</points> </userPointsInfo> </response>