Read configuration definition

GET

/config-definitions/{config-name}

Last modified:2026-10-09 00:46:34

OperationId:ReadSpecificConfigurationDefinition

Returns the definition of one setting, or of every setting whose name matches a * pattern. A configuration definition describes one setting: what it controls, its default value, its data-type, the release it first applies to, and whether a Reseller may set it. Configuration rows (/configurations) then set values for it at each tier.

Super User and Super User Read Only read every definition. Reseller and Route Manager Reseller read the definitions whose config-def-allow-reseller-access is yes, the settings a Reseller may set. Other scopes get 403. The default values of secret-named settings are masked, as for /configurations; a Super User can send include-secrets=yes to get them in clear.

The response is an array. An unknown name returns an empty array. With a pattern, filter further by tags and page with start and limit, which defaults to 100.

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 matching definitions. An unknown name returns an empty array.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/config-definitions/PORTAL_SHOW_SHARED_CONTACTS?tags=portal%2Ccontacts&start=undefined&limit=100&sort=config_name%20asc&include-secrets=no' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "config-name": "PORTAL_NEW_CUSTOM_CONFIG",
    "description": "new description",
    "default": "yes",
    "code-version": "v42.0",
    "config-def-allow-hostname": "yes",
    "config-def-allow-reseller-access": "yes",
    "config-def-default-basic-user": "",
    "config-def-default-call-center-supervisor": "",
    "config-def-default-office-manager": "",
    "config-def-default-reseller": "",
    "config-def-default-super-user": "",
    "data-type": "string",
    "tags": "portal,emergency"
}

Modified at 2026-10-09 00:46:34

Create configuration definition

Update configuration definition