Request: GET /user/profile/fields
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.
Department Administrators, Publishers, and users with a custom role can add users only to the departments they manage and their sub-departments.
Request Headers
Parameter | Description |
---|---|
X-Auth-Account-Url (required) | The base URL of the account, e.g. https://myaccount.ispringlearn.com. |
X-Auth-Email (required) | The login of Account Owner, Account Administrator, Department Administrator, Publishers, or a user with a custom role. |
X-Auth-Password (required) | The password of Account Owner, Account Administrator, Department Administrator, Publishers, or a user with a custom role. |
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 https/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
https/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>