Read settings catalog

GET

/settings/catalog

Last modified:2026-10-04 19:47:02

OperationId:ReadDomainSettingsCatalog

Returns every setting the platform reads, keyed by setting name, with its type, allowed values, default, and the legacy UI configuration name it replaces. Use it to find the names and values to send to the settings endpoints.

The type is advisory. The settings endpoints store any JSON value under any valid name, so check a value against its type before you write it.

Settings in the current catalog:

Setting	Type	Values	Default
`branding.portal-fqdn`	string	any	none
`inventory.did-table`	key	a dial plan name	`DID Table`
`localization.date.day-format`	enum	`j`, `d`	`j`
`localization.date.delimiter`	string	any	`/`
`localization.date.format`	enum	`MDY`, `DMY`, `YMD`	`MDY`
`localization.date.month-format`	enum	`n`, `m`, `M`, `F`	`n`
`localization.date.year-format`	enum	`Y`, `y`	`Y`
`localization.datetime.delimiter`	string	any	a space
`localization.duration.format`	enum	`auto`, `MM:SS`, `HH:MM:SS`, `minutes`, `seconds`	`auto`
`localization.language.fallback`	string	any	`en-US`
`localization.number.country`	string	any	`US`
`localization.time.12-hour`	boolean	any	`true`
`localization.time.delimiter`	string	any	`:`
`localization.time.format`	enum	`HMS`, `SMH`	`HMS`
`phonenumbers.format.hide-domestic-one`	boolean	any	`false`
`phonenumbers.format.pretty-print`	boolean	any	`true`
`phonenumbers.format.remove-plus`	boolean	any	`false`
`phonenumbers.format.remove-pound-prefixes`	boolean	any	`false`
`phonenumbers.format.replace-plus`	boolean	any	`true`
`phonenumbers.format.us-domestic`	boolean	any	`true`
`provisioning.preferred-server`	key	a core server name	none
`provisioning.preferred-transport`	enum	`tls`, `tcp`, `udp`	none
`provisioning.redundancy`	enum	`system default`, `none`, `geography`, `force primary`	none

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

The catalog, as an object keyed by setting name.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/settings/catalog' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Catalog

{
    "branding.portal-fqdn": {
        "default": null,
        "description": "Hostname used to build portal links in outgoing email.",
        "legacy": [
            "PORTAL_FQDN"
        ],
        "type": "string",
        "used-in": [
            "api"
        ]
    },
    "inventory.did-table": {
        "default": "DID Table",
        "description": "Dial plan that holds the phone-number inventory (DID table).",
        "legacy": [
            "PORTAL_INVENTORY_TABLE"
        ],
        "ref": "dialplan",
        "type": "key",
        "used-in": [
            "api"
        ]
    },
    "localization.date.day-format": {
        "default": "j",
        "description": "Day component: j = 1, d = 01.",
        "legacy": [
            "PORTAL_LOCALIZATION_DATE_DAY_FORMAT"
        ],
        "type": "enum",
        "used-in": [],
        "values": [
            "j",
            "d"
        ]
    },
    "localization.date.delimiter": {
        "default": "/",
        "description": "Character between date components, e.g. \"/\" or \"-\".",
        "legacy": [
            "PORTAL_LOCALIZATION_DATE_DELIMITER"
        ],
        "type": "string",
        "used-in": [
            "api"
        ]
    },
    "localization.date.format": {
        "default": "MDY",
        "description": "Order of the date components.",
        "legacy": [
            "PORTAL_LOCALIZATION_DATE_FORMAT"
        ],
        "type": "enum",
        "used-in": [
            "api"
        ],
        "values": [
            "MDY",
            "DMY",
            "YMD"
        ]
    },
    "localization.date.month-format": {
        "default": "n",
        "description": "Month component: n = 1, m = 01, M = Jan, F = January.",
        "legacy": [
            "PORTAL_LOCALIZATION_DATE_MONTH_FORMAT"
        ],
        "type": "enum",
        "used-in": [],
        "values": [
            "n",
            "m",
            "M",
            "F"
        ]
    },
    "localization.date.year-format": {
        "default": "Y",
        "description": "Year component: Y = 2026, y = 26.",
        "legacy": [
            "PORTAL_LOCALIZATION_DATE_YEAR_FORMAT"
        ],
        "type": "enum",
        "used-in": [],
        "values": [
            "Y",
            "y"
        ]
    },
    "localization.datetime.delimiter": {
        "default": " ",
        "description": "Character between the date and the time.",
        "legacy": [
            "PORTAL_LOCALIZATION_DATETIME_DELIMITER"
        ],
        "type": "string",
        "used-in": []
    },
    "localization.duration.format": {
        "default": "auto",
        "description": "How a call duration is rendered, everywhere one is shown.",
        "legacy": [
            "PORTAL_CALL_QUEUE_STAT_TIME_FORMAT",
            "PORTAL_CALL_HISTORY_DURATION_FORMAT"
        ],
        "type": "enum",
        "used-in": [
            "api"
        ],
        "values": [
            "auto",
            "MM:SS",
            "HH:MM:SS",
            "minutes",
            "seconds"
        ]
    },
    "localization.language.fallback": {
        "default": "en-US",
        "description": "Language used when the requested one has no translation.",
        "legacy": [
            "PORTAL_LOCALIZATION_LANGUAGE_FALLBACK"
        ],
        "type": "string",
        "used-in": []
    },
    "localization.number.country": {
        "default": "US",
        "description": "ISO country code phone numbers are formatted for, e.g. \"US\".",
        "legacy": [
            "PORTAL_LOCALIZATION_NUMBER_FORMAT"
        ],
        "type": "string",
        "used-in": [
            "api"
        ]
    },
    "localization.time.12-hour": {
        "default": true,
        "description": "Render times as 12-hour with AM/PM rather than 24-hour.",
        "legacy": [
            "PORTAL_LOCALIZATION_TIME_12_HOUR_FORMAT"
        ],
        "type": "boolean",
        "used-in": [
            "api"
        ]
    },
    "localization.time.delimiter": {
        "default": ":",
        "description": "Character between time components, normally \":\".",
        "legacy": [
            "PORTAL_LOCALIZATION_TIME_DELIMITER"
        ],
        "type": "string",
        "used-in": []
    },
    "localization.time.format": {
        "default": "HMS",
        "description": "Order of the time components.",
        "legacy": [
            "PORTAL_LOCALIZATION_TIME_FORMAT"
        ],
        "type": "enum",
        "used-in": [],
        "values": [
            "HMS",
            "SMH"
        ]
    },
    "phonenumbers.format.hide-domestic-one": {
        "default": false,
        "description": "Drop the leading 1 from NANPA domestic numbers.",
        "legacy": [
            "PORTAL_PHONENUMBER_HIDE_DOMESTIC_ONE"
        ],
        "type": "boolean",
        "used-in": [
            "api"
        ]
    },
    "phonenumbers.format.pretty-print": {
        "default": true,
        "description": "Apply national formatting, e.g. (555) 123-4567.",
        "legacy": [
            "PORTAL_PHONENUMBER_PRETTY_PRINT"
        ],
        "type": "boolean",
        "used-in": []
    },
    "phonenumbers.format.remove-plus": {
        "default": false,
        "description": "Strip a leading \"+\" before dialling.",
        "legacy": [
            "PORTAL_PHONENUMBER_REMOVE_PLUS_ON_CALL"
        ],
        "type": "boolean",
        "used-in": []
    },
    "phonenumbers.format.remove-pound-prefixes": {
        "default": false,
        "description": "Strip a leading \"#\" prefix from numbers.",
        "legacy": [
            "PORTAL_PHONENUMBER_REMOVE_POUND_PREFIXES"
        ],
        "type": "boolean",
        "used-in": []
    },
    "phonenumbers.format.replace-plus": {
        "default": true,
        "description": "Rewrite an 011/00 international prefix to \"+\".",
        "legacy": [
            "PORTAL_PHONENUMBER_REPLACE_PLUSSIGN"
        ],
        "type": "boolean",
        "used-in": [
            "api"
        ]
    },
    "phonenumbers.format.us-domestic": {
        "default": true,
        "description": "Format numbers as US domestic. Off for international dial plans.",
        "legacy": [
            "PORTAL_PHONENUMBER_US_DOMESTIC"
        ],
        "type": "boolean",
        "used-in": [
            "api"
        ]
    },
    "provisioning.preferred-server": {
        "default": null,
        "description": "Core server (NDP servers_config name) the domain's devices provision and register against; its geo group is the failover set GET /v2/domains/{domain}/sip-servers answers.",
        "legacy": [
            "PORTAL_DEVICE_NDP_SERVER"
        ],
        "ref": "ndpserver",
        "type": "key",
        "used-in": []
    },
    "provisioning.preferred-transport": {
        "default": null,
        "description": "Transport of the one SRV record GET /v2/domains/{domain}/sip-servers returns as preferred-srv; falls back to PORTAL_INVENTORY_PHONES_TRANSPORT_TYPE when that holds a transport, else tls.",
        "type": "enum",
        "used-in": [],
        "values": [
            "tls",
            "tcp",
            "udp"
        ]
    },
    "provisioning.redundancy": {
        "default": null,
        "description": "How NDP picks a device's secondary server; none keeps the preferred server alone.",
        "legacy": [
            "PORTAL_DEVICE_REDUNDANCY"
        ],
        "type": "enum",
        "used-in": [],
        "values": [
            "system default",
            "none",
            "geography",
            "force primary"
        ]
    }
}

Modified at 2026-10-04 19:47:02

Delete reseller setting

List domain settings