Skip to content
OrganizationRoleObject

A reusable permission template for organization staff, mirroring BusinessRole at the organization tier: a named bundle of OrganizationPermission flags (what members may do on org-scoped surfaces) plus a BusinessPermission bitmask conferred on every child business of the organization. Editing a role updates the effective permissions of everyone who holds it (live RBAC, not a one-time copy).

Fields

idID!
organizationOrganization!
nameString!
descriptionString
permissionsInt!

Combined bitmask of OrganizationPermission flags this role grants on organization-scoped surfaces.

childBusinessPermissionsInt!

Combined bitmask of BusinessPermission flags this role confers on every child business of the organization. 0 means org-scoped access only. A role whose permissions carries Admin grants all business permissions on children regardless of this value.

builtInBoolean!

True when this role was seeded from a built-in preset (e.g. Regional manager).

staffCountInt!

Number of staff members assigned this role.

Staff members assigned this role, ordered by name.

createdAtDateTime!

Used in

OrganizationRole