Skip to content

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

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

idstring

The opportunity's unique identifier

outcomestring

The result of the engagement. For calls, this is the call disposition (for example, connected, no_answer, left_voicemail, busy, wrong_number). For meetings, this is the meeting outcome (for example, completed, no_show, rescheduled, canceled). Values are normalized to lowercase snake_case where possible; provider-specific labels may be returned when no standard mapping exists.

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

recording_urlstring

A URL to access the call or meeting recording when available from the CRM. May be a direct media URL or a CRM-hosted review page, depending on the provider.

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

transcriptstring

The full text transcript of the call or meeting when available from the CRM. Structured or speaker-segmented transcripts are flattened to plain text in this field.

updated_atstring · date-time

The date and time of the engagement's last update