GET
/v1/admin/settings
List Settings
curl https://api.{cluster}.{platform}.voiger.io/v1/admin/settings?category= \
-H "Cookie: sid=$VOIGER_SESSION" \
-H "x-workspace-code: your-workspace-code"
const res = await fetch("https://api.{cluster}.{platform}.voiger.io/v1/admin/settings", {
method: "GET",
credentials: "include",
headers: { "x-workspace-code": "your-workspace-code" },
})
const data = await res.json()
Parameters
x-workspace-code
string
required
in header
category
string
required
in query
Filter settings by category. The `dncr` category holds the
Do Not Call Registry integration config; secret keys inside its
`config` map are returned masked as `{ "set": true|false }` —
see `DncrSettingExample` in `responses.yml`.
value
any
Setting value (can be string, number, boolean, or object).
For `category: "dncr"`, `name: "config"`, the response value is
the provider's `config` map with secret keys masked to
`{ "set": true | false }` (see `MaskedSecret`). Public keys are
returned in clear.
category
string
Setting category
json · 200
{
"settings": [
{
"name": "country",
"value": "CA",
"category": "general"
},
{
"name": "timezone",
"value": "America/Toronto",
"category": "general"
},
{
"name": "clean_calls_inbound",
"value": 45,
"category": "kpis"
},
{
"name": "sla",
"value": {
"formula": "speed_of_answer",
"call_answered_threshold": 30,
"threshold_ignore_abandoned_calls": 5,
"percentage_answered_call": 80
},
"category": "kpis"
},
{
"name": "record_all_calls",
"value": true,
"category": "permissions"
}
]
}