View the Preferences

This API allows the user to view the preferences set in your account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

API Response explanation

FieldDescriptionData Type
preferenceIdUnique identifier representing the preferenceInteger
nameName of the preferenceString
descriptionDescription of the preferenceString
valueTypeIdUnique identifier representing the value typeInteger
valueTypeConstraintValues that are acceptable for this preferenceString
categoryIdUnique identifier representing the catagoryInteger
parentIdFor internal Azuga useInteger
valueThe value of the preference based on preferenceId/preferenceNameString
level

The level set for the preference.

0 - Global level(Across Azuga customers)
20 - Customer Level Preference
30 - User Level Preference

Integer
objectId

This field populates data based on the level of the preference.

For level = 20, ObjectId = CustomerId
For level = 30, ObjectId = UserId

String
categoryNameFor internal Azuga useString
displayKeyFor internal Azuga useString
displayNameName of the preference displayed in AzugaString
hidden

Boolean representing whether the preference is hidden from Azuga

True = Hidden in Azuga web platform
False = Available in Azuga web platform

Boolean
errorError description - If anyList<Error>
Query Params
boolean
required

Set this parameter to true for the system to identify that the web version is 2

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json