List domain settings

GET

/domains/{domain}/settings

Last modified:2026-10-09 01:02:37

OperationId:ListDomainSettings

Returns the settings in effect for a domain, one row per setting, with the tier each value came from. Every user can read the settings of their own domain, and Resellers can read the domains in their territory.

Settings resolve in 3 tiers. A system setting applies to every domain, a reseller setting overrides it for the domains in that territory, and a domain setting overrides both for one domain. Send effective=no to get only the rows stored on the domain.

Append /list to the path to return only setting, source, reseller, and domain for each row. GET /settings/catalog lists every setting the platform reads.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Responses

🟢200OK

application/json

The settings. A domain with no settings at any tier returns an empty array.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//settings?effective=yes' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Effective settings

[
    {
        "domain": "example.com",
        "reseller": "example-reseller",
        "setting": "localization.date.format",
        "value": "DMY",
        "source": "reseller",
        "domain-editable": "no",
        "reseller-editable": "yes",
        "description": "Order of the date components."
    },
    {
        "domain": "example.com",
        "reseller": "example-reseller",
        "setting": "localization.time.12-hour",
        "value": true,
        "source": "domain",
        "domain-editable": "yes",
        "reseller-editable": "yes",
        "description": "Render times as 12-hour with AM/PM rather than 24-hour."
    },
    {
        "domain": "example.com",
        "reseller": "example-reseller",
        "setting": "phonenumbers.format.us-domestic",
        "value": true,
        "source": "system",
        "domain-editable": "yes",
        "reseller-editable": "yes",
        "description": "Format numbers as US domestic. Off for international dial plans."
    }
]

Modified at 2026-10-09 01:02:37

Read settings catalog

Create or update domain setting