Skip to main content

Retrieve active and suspended extensions report

GET 

/api/v1/domains/:domain_uuid/reports/active-extensions

Returns the current "Active and suspended extensions per domain" report for one domain as a single JSON object. No export or email is generated.

Access rules:

  • Caller must have access to the target domain (domain scope).
  • Caller must have the extension_view permission.

Counts follow the report's definitions:

  • Total extensions includes all extensions, including disabled extensions.
  • Suspended extensions have their advanced setting suspended set to true.
  • Active extensions equals total minus suspended. Missing advanced settings mean the extension is not suspended. This is not a SIP registration count.
  • Active mobile apps counts extensions with a linked mobile app in the same domain whose stored status is 1, independently of extension suspension.
  • Domains without extensions return zero for every count.

Request​

Responses​

Success