Role
A Role defines what actions a User Account can perform within the system, and may connect a User Account with a Contact via a ContactAssignment.
A user logs in with a Login, which is connected to an Account, which can have one or more Roles that define their Permissions.
Role implements the Assignable interface.
Common User Roles include:
Agent
Commercial Agent
Company Administrator
Inside Sales Agent (ISA)
Loan Officer
Marketer
Recruiter
OBJECT SCHEMA
| Field | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | The unique ID of this object. |
name | string | Yes | The name of the Role. |
displayName | string | No | The display name of the Role. |
description | string | No | A system-provided description of the Role. |
profile | Profile | No | The user profile. |
typename | string | Yes | The GraphQL type name. Aways "Role". |
* represents a required field.
Updated July 23, 2026