Skip to main content
GET
Aggregate member counts, buckets and facets

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
/oauth2/token/
FlowPassword
Token URL
/api/partners/v2.0/auth/token

Path Parameters

org_id
string<uuid>
required

The organization ID to summarise

Query Parameters

engaged
boolean

true: count only members who have ever owned a device or made an onboarding attempt, matching the list's engaged filter.

Response

200 - application/json

OK

Org-wide aggregate for the console Users screen.

total_members
integer
required
members_with_device
integer
required
deleted_members
integer
required
support_buckets
SupportBucketOutput · object[]
required
health_buckets
HealthBucketOutput · object[]
required
facet_options
UsersFacetOptionsOutput · object
required

The filter-dropdown options present across the org: distinct device OEMs (sorted) and the device kinds with at least one operational device (same tokens the users-list device_kind filter accepts, minus the any sentinel).