How to list licence counts for all customers¶

The Enclave Partner API returns every customer's licensed counts alongside the number of systems and gateways in use, in a single request. This is useful for reconciling licences against a PSA or billing system, and for spotting customers whose usage has moved away from what is licensed.

Before starting¶

The request is authenticated with the partner's API key, the same key used by the Gradient MSP integration. The key is managed, and the Partner ID shown, on the Integrations > Gradient MSP page in the Enclave Partner Portal.

If a key already exists, use it. Generating a new key immediately invalidates the existing one, and anything using it, including Gradient MSP, loses access.
If no key exists, a Partner User with the Owner or Admin role selects Generate API Key. The key is displayed once, so copy it straight away.

The key is read-only. It cannot make changes to the partner account or to any customer.

Listing the customers¶

Replace {API-KEY} and {PARTNER-ID} with the values from the Integrations > Gradient MSP page.

Linux/macOSWindows PowerShell

KEY={API-KEY}
PARTNER={PARTNER-ID}

curl -s -H "Authorization: Bearer $KEY" \
  "https://partner-api.enclave.io/partner/$PARTNER/gradient/customers?per_page=200" \
  | jq -r '.items[] | [.id, .name, .licensedSystems, .licensedGateways, .enrolledSystems, .configuredGateways] | @tsv'

$key = '{API-KEY}'
$partnerId = '{PARTNER-ID}'

(Invoke-RestMethod -Uri "https://partner-api.enclave.io/partner/$partnerId/gradient/customers?per_page=200" `
    -Headers @{ Authorization = "Bearer $key" }).items |
    Select-Object id, name, licensedSystems, licensedGateways, enrolledSystems, configuredGateways |
    Format-Table

The fields returned for each customer are:

Field	Meaning
`id`	The customer's organisation ID.
`name`	The customer's name, as shown in the Enclave Partner Portal.
`licensedSystems`	The customer's licensed count of systems.
`licensedGateways`	The customer's licensed count of gateways.
`enrolledSystems`	The number of systems currently enrolled.
`configuredGateways`	The number of gateways currently in use.

The licensed and in-use counts can differ. See Billing - Automatic seat adjustment for how licensed counts follow usage.

A single request returns up to 200 customers. Partners with more than 200 customers repeat the request with &page=1, &page=2 and so on to retrieve the rest.

Having problems? Contact us at support@enclave.io or visit our support options.

Last updated November 3, 2026