list_settings_get

This returns the corresponding setting if the name is specified or the complete list of settings for the ID (list id).

See Also

Argument

Required

Type

Description

id

yes

string

The List ID. The list_list API with detailed enable will return the List ID.

name

no

string

This is the Setting name.  See List Settings.

format

no

string

The format of the output for the API: text, json or xml. The default is text.

callback

no

string

This only works with Direct APIs. This is a JavaScript function that should be called after the API is completed. This function will be called with the response of the API.  Please note: It can only be used when requesting this API via AJAX request.  More Information can be found here.

Example

servername/webadmin/api/list_settings_get.php?id=VALUE

Output:

OK:

listservice_enabled=>0

listservice_run_interval=>0

 

Version: 6.2.3