List territories

Returns territories with their SMTP settings and live totals: domains, users, and active calls. A territory is the configuration record that a Reseller's domains belong to, and reseller is its name.

Super User and Super User Read Only see every territory. A Reseller sees only its own, as a one-item array. A Reseller that filters on another territory gets 403, and so does every other scope.

Filter with reseller. Page with start and limit, 100 territories by default, and sort by reseller or description. Use GET /resellers/count for a total, and GET /resellers/list for names and descriptions only.

The totals are counted on every read. users-total leaves out system users. email-send-smtp-password is masked. Super User can send include-secrets=yes for the plain text. SMTP settings that are not set are left out.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

application/json

The territories you can see, possibly an empty array. email-send-smtp-password is masked unless you sent include-secrets=yes.

Bodyapplication/json

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/resellers?reseller=example-reseller&limit=undefined&start=undefined&sort=description%20desc&include-secrets=yes' \ --header 'Authorization: Bearer <token>'

{ "description": "postfix test domain", "reseller": "20463.test", "domains-total": 8, "users-total": 43, "active-calls-against-license-count": 0, "active-calls-offnet-current": 0 }

Request

Responses