Rolebase Developers
API Reference

org

The top-level entity that contains all other entities such as circles, roles, members, meetings, and tasks.

Fields

FieldTypeDescription
iduuidUnique identifier for the organization
nameStringName of the organization
slugStringURL-friendly unique identifier (optional)
archivedBooleanWhether the organization is archived (default: false)
createdAtTimestampWhen the organization was created
defaultGraphViewStringDefault graph view setting (optional)
protectGovernanceBooleanWhether governance changes are restricted to leaders (default: false)
shareMembersBooleanWhether member information is publicly shared (default: false)
shareOrgBooleanWhether organization information is publicly shared (default: false)

Relationships

One-to-One:

  • org_subscription β€” The organization’s subscription information

One-to-Many:

  • circles β€” Organizational circles
  • decisions β€” Organization decisions
  • files β€” Organization files
  • logs β€” Activity logs
  • meeting_templates β€” Meeting templates
  • meetings β€” Meetings
  • meetings_recurring β€” Recurring meetings
  • members β€” Organization members
  • news β€” News items
  • roles β€” Organization roles
  • task_views β€” Task views
  • tasks β€” Tasks
  • threads β€” Discussion threads

Query Examples

Get a Specific Organization

query GetOrganization($id: uuid!) {
  org_by_pk(id: $id) {
    id
    name
    slug
    archived
    createdAt
    members {
      id
      name
      role
    }
    circles {
      id
      name
    }
  }
}

Mutation Examples

Update an Organization

mutation UpdateOrganization {
  update_org_by_pk(
    pk_columns: { id: "your-org-id" }
    _set: {
      name: "New Organization Name"
      shareMembers: true
      protectGovernance: true
    }
  ) {
    id
    name
    shareMembers
    protectGovernance
  }
}

Permissions

  • Owner: Full access to all organization settings and data
  • Admin: Can manage most organization settings and data
  • Member: Can view organization data based on sharing settings
Info Circle Notes

The slug field must be unique across all organizations. When protectGovernance is enabled, only circle leaders can modify governance-related entities. The shareMembers and shareOrg flags control visibility of organization data to external users.