Skip to content

Engagements Object

Relationships

Schema relationships 
graph LR
    Engagements -->|"engagement_type"| EngagementTypes
    Engagements -->|"notes"| Notes
    Engagements -->|"project"| Projects
    Engagements -->|"account"| Accounts
    Engagements -->|"contact"| Contacts
    Engagements -->|"opportunity"| Opportunities
    Engagements -->|"lead"| Leads

Properties

idstring
required·

The engagement's unique identifier

accountobject

The engagement's account

References: Accounts → id
idstring

The account's unique identifier

contactobject[]

The engagement's contacts

References: Contacts → id
idstring

The contact's unique identifier

contentstring

The engagement's content

created_atstring · date-time

The date and time of the engagement's creation

custom_fieldsRecord<string, any>

All the custom fields present on the engagement

directionstring

The engagement's direction

durationstring

The engagement's duration

end_timestring · date-time

The engagement's end time

engagement_typestring

The engagement's type - call, email, meeting or raw response

References: EngagementTypes → id
internal_notesstring

The engagement's internal notes

leadobject[]

The engagement's lead

References: Leads → id
idstring

The lead's unique identifier

notesobject[]

The engagement's notes

References: Notes → id
idstring

The note's unique identifier

opportunityobject[]

The engagement's opportunity

References: Opportunities → id
idstring

The opportunity's unique identifier

ownerobject

The engagement's owner

idstring

The owner's unique identifier

phone_numbersobject[]
extensionstring

The extension of the phone number

idstring

The unique identifier of the phone number

numberstring

The phone number

typestring

The phone number type

projectobject

The engagement's project

References: Projects → id
idstring

The project's unique identifier

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_timestring · date-time

The engagement's start time

statusstring

The engagement's status

subjectstring

The engagement's subject

updated_atstring · date-time

The date and time of the engagement's last update