Request: GET /user/profile/fields

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles. 

Department Administrators, and users with a custom role can add users only to the departments they manage and their sub-departments. 

Request Headers

ParameterDescription
Authorization (required)Access token. You can obtain a token by making a request

Response Parameters

ParameterDescription
userFieldInfoAn array with data about the user profile field
userFieldInfoIdThe ID of the profile field
labelThe name of the profile field
typeThe field type.

Possible values:
  • login
  • email
  • first_name
  • last_name
  • job_title
  • string
  • country
  • phone
  • birthdate
isUnique

The parameter shows if the field is unique

Possible values:

0 — not unique (false)
1 — is unique (true)

isRequiredThe parameter shows if the field is required

Possible values:

0 — is optional (false)
1 — is required (true)

orderPriority

The ordinal number of the field – the count starts from 0

For example, for the first field in the list, the parameter orderPriority=0, etc

values [] (optional)An array with the data of the fields from the list. For example, the country field type includes a list of countries
fieldThe dropdown list item. Each field contains both the name field and the value field

Possible Response Codes

CodeTextDescription
200OkThe request has been processed successfully
400Bad RequestA request error
401UnauthorizedAn authorization error
403Permission deniedThe user doesn't have enough permissions to complete the request

 

Sample Request

GET /user/profile/fields https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

 

 

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>
  • No labels