Skip to content

Get active-tenant member stats

GET
/api/v1/tenant/members/stats
curl --request GET \
--url http://localhost:3000/api/v1/tenant/members/stats \
--header 'X-API-Key: <X-API-Key>'

Returns aggregate stats (total, byStatus, byRole) for members of the active organization (resolved from URL slug / active switch).

Stats retrieved successfully

Media type application/json
object
total
required

Total number of users

number
byStatus
required

User counts by status

object
active
required

Number of active users

number
inactive
required

Number of inactive/disabled users

number
pending
required

Number of pending users

number
byRole
required

User counts by role

object
admin
required

Number of admin users

number
operator
required

Number of operator users

number
viewer
required

Number of viewer users

number
Example
{
"total": 25,
"byStatus": {
"active": 20,
"inactive": 3,
"pending": 2
},
"byRole": {
"admin": 3,
"operator": 8,
"viewer": 14
}
}

Unauthorized

Forbidden - Insufficient permissions