SysmosSysmos Docs
API Reference

Organizations

Manage organizations and members via the Sysmos API.

Organizations are the top-level container in Sysmos. All monitors, servers, and team members belong to an organization.

List Organizations

GET /v1/organizations

Returns all organizations the authenticated user belongs to.

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "Acme Corp",
      "role": "owner",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Get Organization

GET /v1/organizations/:id
{
  "id": "org_abc123",
  "name": "Acme Corp",
  "plan": "pro",
  "member_count": 5,
  "monitor_count": 12,
  "server_count": 8,
  "created_at": "2025-01-01T00:00:00Z"
}

Update Organization

PATCH /v1/organizations/:id

Requires: org:update permission

{
  "name": "Acme Corp (Updated)"
}

Members

List Members

GET /v1/organizations/:id/members
{
  "members": [
    {
      "id": "usr_def456",
      "email": "admin@acme.com",
      "role": "owner",
      "joined_at": "2025-01-01T00:00:00Z"
    },
    {
      "id": "usr_ghi789",
      "email": "dev@acme.com",
      "role": "member",
      "joined_at": "2025-01-05T00:00:00Z"
    }
  ]
}

Invite Member

POST /v1/organizations/:id/members/invite

Requires: members:invite permission

{
  "email": "newuser@acme.com",
  "role": "member"
}

Roles

RolePermissions
OwnerFull access, billing, delete organization
AdminManage members, monitors, servers, integrations
MemberCreate and edit monitors, view servers
ViewerRead-only access to all data

Remove Member

DELETE /v1/organizations/:id/members/:memberId

Requires: members:remove permission

On this page