List custom scopes

Returns the custom scopes, sorted by name. Requires Super User or Super User Read Only scope.

A custom scope takes a built-in parent scope and removes rights from it, so it can never do more than its parent. Users and API keys are assigned it by name. Its rights come from these settings:

modifications. Per-object limits, keyed by API object name: none removes the object, ro allows reads only, update-only allows reads and updates, and no-delete allows everything but deletes.

read-only. yes refuses every write, on every object.

enabled. no refuses every token issued under the scope until you set it back to yes.

Changes apply to tokens already issued within seconds. Tokens are not reissued.

Send include-built-in=yes to add the built-in scopes after the custom ones, each with built-in: yes, so one call fills a scope picker. hidden controls only whether a scope appears in GET /scopes. It does not change what the scope can do or who holds it. Hidden scopes are left out unless you send include-hidden=yes.

Filter with parent-scope and enabled, page with limit and start, and order with sort. Paging applies to custom scopes only; built-in entries are added after it. For the number of custom scopes, use GET /scopes/count.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/scopes?parent-scope=Super%20User&enabled=yes&include-built-in=yes&sort=name%20asc&start=undefined&limit=100&include-hidden=yes' \ --header 'Authorization: Bearer <token>'

[ { "name": "Front Desk Manager", "parent-scope": "Office Manager", "description": "Office Manager without call queue changes", "read-only": "no", "modifications": { "callqueue": "ro" }, "enabled": "yes", "hidden": "no", "built-in": "no" }, { "name": "Platform Manager", "parent-scope": "Super User", "description": "Operations admin with no platform configuration or routing changes", "read-only": "no", "modifications": { "nsconfig": "none", "route": "ro" }, "enabled": "yes", "hidden": "no", "built-in": "no" } ]

Request

Responses