Users & Companies

The Ecosystem module is the foundation of Kanvas. It manages identity, tenancy, and access — users, companies, branches, roles, and permissions. Every other module is scoped to a company.

User

Users are people who access the system — team members, agents, or admins.

Company

Companies are the primary tenant boundary. All data is scoped to a company.

Queries

# List users
query {
  users(first: 20, where: { column: IS_ACTIVE, operator: EQ, value: true }) {
    data {
      id displayname email
      roles { name }
      default_company
    }
    paginatorInfo { total hasMorePages }
  }
}

# List companies
query {
  companies(first: 20) {
    data {
      id uuid name website
      total_users total_branches
      branches { id name }
    }
  }
}

Mutations

# Update a user
mutation {
  updateUser(id: 1, data: { firstname: "Jane", lastname: "Smith" }) {
    id displayname
  }
}

# Create a company
mutation {
  createCompany(input: { name: "New Corp", website: "https://newcorp.com" }) {
    id uuid name
  }
}

# Create a branch
mutation {
  createCompanyBranch(company_id: 1, input: { name: "West Coast Office" }) {
    id uuid name
  }
}

# Add user to company
mutation {
  addUserToCompany(user_id: 5, company_id: 1) { id }
}

Roles & Permissions

# List roles
query {
  roles(first: 50) {
    data { id name abilities { name } }
  }
}

# Check permission
query {
  can(check: "create-leads")
}