JSON API » preferences » preferences/get

Gets the value of a preference for the authentication user.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name of preference to get.	Yes
default	String	A default value to return if not yet set.	No	Empty string.

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

Value of preference.

Example: With required parameters

http://enswitch.example.com/api/json/preferences/get/?auth_username=user;auth_password=password;name=phone

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "value":"1234567" } }

Change history

Version	Changes
3.13	Function added.