TwentyThree Developer APIAPI Method: /api/setting/list

API Method: /api/setting/list

Last updated on August 9, 2016.

List account settings, optionally include options.

Parameters

ParameterDescription
settings Comma-separated list of settings to include. Leave empty to include all user-readable settings.
include_options_p Include a list of all options for each relevant setting.
Default: 0
Valid values: 1 and 0

Permission level

The minimum required permission level is:

read

Example XML Response

<response status="ok" permission_level="super" cached="0">
  <setting setting="company_name" value="TwentyThree Aps" update_p="1"/>
  <setting setting="country_iso" value="US" update_p="1">
    <options>
      <option value="AF" label="Afghanistan"/>
      <option value="AL" label="Albania"/>
      <option value="DZ" label="Algeria"/>
      <option value="AS" label="American Samoa"/>
      <option value="AD" label="Andorra"/>
      <option value="AO" label="Angola"/>
      ...
    </options>
  </setting>
</response>

Example JSON Response

{
    "status": "ok", 
    "permission_level":"super",
    "cached":"0",
    "settings":[
        {
            "setting": "company_name",
            "value": "TwentyThree Aps",
            "update_p": 1
        },
        {
            "setting": "country_iso",
            "value": "US",
            "update_p": 1,
            "options": [
                {"value": "AF", "label": "Afghanistan"},
                {"value": "AL", "label": "Albania"},
                {"value": "DZ", "label": "Algeria"},
                {"value": "AS", "label": "American Samoa"}
                ...
            ]
        }
    ],
    "p": "1",
    "size": "1",
    "site": {...},
    "endpoint": "/api/setting/list"
}