Skip to content

Get Engagements

Endpoint

http
GET /unified/crm/engagements/{id}
Integrations supported
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM

Path parameters

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
engagement_type
string

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

Integration specific notes
  • HubSpotThe engagement's type. Required unless contact_id is also present. If specifying contact_id, this shouldn't be specified.
  • SalesforceThe engagement's type
All possible enum values:
  • call
  • email
  • meeting
Required in
  • Salesforce
  • Zoho CRM
Supported in
  • HubSpot
contact_id
string

The contact's unique identifier. Required when engagement_type is email.

Supported in
  • Zoho CRM

Response Body

id
string
REQUIRED · 

The engagement's unique identifier

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
owner
object

The engagement's owner

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string

The owner's unique identifier

content
string

The engagement's content

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
subject
string

The engagement's subject

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
direction
string

The engagement's direction

Supported in
  • HubSpot
  • Zoho CRM
engagement_type
string

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

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
status
string

The engagement's status

Supported in
  • Capsule
start_time
string · date-time

The engagement's start time

Supported in
  • HubSpot
  • Salesforce
  • Zoho CRM
end_time
string · date-time

The engagement's end time

Supported in
  • HubSpot
  • Salesforce
  • Zoho CRM
duration
string

The engagement's duration

Supported in
  • Salesforce
  • Zoho CRM
project
object

The engagement's project

Supported in
  • Capsule
id
string

The project's unique identifier

account
object

The engagement's account

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
id
string

The account's unique identifier

contact
object[]

The engagement's contacts

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string

The contact's unique identifier

opportunity
object[]

The engagement's opportunity

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
id
string

The opportunity's unique identifier

created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
updated_at
string · date-time

The date and time of the engagement's last update

Supported in
  • Capsule
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
remote_data
object

Raw data returned from the remote API call.