Get aggregate organization stats

GET

/api/v1/organizations/stats

const url = 'http://localhost:3000/api/v1/organizations/stats';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns total organization count and counts by status. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Aggregate stats retrieved successfully

application/json

object

total

required

Total number of organizations

number

byStatus

required

Organization counts grouped by status

object

active

required

Number of active organizations

number

suspended

required

Number of suspended organizations

number

pending

required

Number of pending organizations

number

disabled

required

Number of disabled organizations

number

Example

{
  "total": 16,
  "byStatus": {
    "active": 10,
    "suspended": 2,
    "pending": 3,
    "disabled": 1
  }
}

401

Unauthorized

403

Forbidden - Super Admin required