Skip to main content
GET
/
api
/
organizations
/
dashboard
Get dashboard data (Admin and SuperAdmin only)
curl --request GET \
  --url https://your-instance.example.com/api/organizations/dashboard \
  --header 'Authorization: Bearer <token>'
{
  "stats": {
    "totalOrganizations": 12,
    "totalUsers": 84,
    "totalAdmins": 18
  },
  "organizations": [
    {
      "_id": "5f7b1c2e8a1d4e0012c3b400",
      "name": "Acme Corp",
      "address": "123 Yonge St, Toronto, ON",
      "phoneNumber": "+14165550100",
      "loginDisabled": false,
      "users": [
        {
          "_id": "5f7b1c2e8a1d4e0012c3b4a6",
          "fullName": "Alex Admin",
          "email": "admin@acme.example",
          "accessRole": "ADMIN"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Dashboard data returned

stats
object
organizations
object[]