You can get the list of the user profile fields by sending a GET request to the following URL: /user/profile/fields.
Permissions to run the request: Account Owner, Administrators, Department Administrators, Authors.
Request Headers
| Parameter | Description |
|---|---|
| X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
| X-Auth-Email (required) | Login of Account Owner, Administrator, Department Administrator, or Author. |
| X-Auth-Password (required) | Password of Account Owner, Administrator, Department Administrator, or Author. |
After the request has been completed, the system returns the response with the 200 code. The body of the response will contain xml data with the list of the user profile fields.
Possible Response Codes
| Code | Text | Description |
|---|---|---|
| 200 | Ok | The request has been processed successfully. |
| 400 | Bad Request | A request error. |
| 401 | Unauthorized | An authorization error. |
| 403 | Permission denied | The user doesn't have enough permissions to complete the request. |
Sample Request
GET /user/profile/fields HTTP/1.1 Host: api-learn.ispringlearn.com X-Auth-Account-Url: https://myaccount.ispringlearn.com X-Auth-Email: email@email.net X-Auth-Password: password
Sample Response
HTTP/1.1 200 OK Connection: close <?xml version="1.0" encoding="UTF-8"?> <response> <userFieldInfo> <userFieldInfoId>USER_DEFINED_FIELD3</userFieldInfoId> <name>string</name> <label>string</label> <type>string</type> <isUnique>true</isUnique> <isRequired>true</isRequired> <orderPriority>0</orderPriority> <values> <field> <name>string</name> <value>string</value> </field> </values> </userFieldInfo> </response>