Case roles in Core

Introduction

Contacts such as employees, persons, and companies can be assigned different roles on a case. Each personnel related role such as Broker and ResponsibleBroker can only be assigned to a single employee at a time, while other roles associated with stakeholders such as Buyers and Sellers can in some cases be assigned to multiple contacts at a time.

Retrieving personnel related case roles

To retrieve personnel related case roles, use the following endpoint:

/flow/api/Cases/{caseId}/Roles?$filter=
    Type eq 'ResponsibleBroker' or 
    Type eq 'Broker' or 
    Type eq 'AssociateBroker' or 
    Type eq 'AssistantBroker' or 
    Type eq 'SettlementResponsible' or 
    Type eq 'SettlementCompany' or 
    Type eq 'RealEstateRepresentative' or 
    Type eq 'Assistant'

You will need the following permissions:

CaseRoles - Read

Retrieving other common case roles

To retrieve other case roles that are not related to the personnel on a case, use the following endpoint:

/flow/api/Cases/{caseId}/Roles?$filter=
    Type eq 'Seller' or 
    Type eq 'Buyer' or 
    Type eq 'OriginalBuyer'
    Type eq 'BuyerAssignee' or 
    Type eq 'Assignee' or 
    Type eq 'Owner' or 
    Type eq 'Spouse' or 

For a complete list of all role types you can filter by, please refer to our swagger documentation.

AI Assistant (Beta)