OrgUnit (Interface)

An Organizational Unit (also known as OrgUnit or OU) represents a group of User Accounts and their common business. Users are granted access to OUs via Roles and Workspaces.

Users are granted membership to OUs via a relationship with one or more of their Roles.

OrgUnit implements the Assignable interface.

Example

A User Account with an Agent Role can be a member of a Company OU. That same Agent Role can also be a member of an Agent Team OU and a Referral Team OU.

58846ea3d62c744430f8b2152dd940a139954463400b87da93ca115638adf278-agent-member-example

INTERFACE SCHEMA

All objects implementing this interface must include the required fields below.

FieldTypeRequiredDescription
idUUIDYes

The unique ID of this object.

namestringYes

A short name for the object.

displayNamestringNo

The name used when displaying the object in the UI.

emailsEmail[]No

The email addresses associated with this OU.

telephonesTelephone[]No

The telephones associated with this OU.

addressesAddress[]No

The addresses associated with this OU.

typenamestringYes

The GraphQL type name of the object type.

* indicates a required field

ENTITIES IMPLEMENTING INTERFACE

  • AgentTeam

  • Company

  • ReferralTeam

  • Office

Updated July 23, 2026