JSON API » preferences » preferences/list

Gets the fields of all the preferences that have been set for the authentication user.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes

Responses

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

Data returned

An array of fields, corresponding to the rows of the preferences table in the database.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "name":"callerid", ... }, { "name":"name", ... } }

Change history

VersionChanges
4.0Function added.