Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...