Get Engagements ​
Endpoint ​
GET /unified/crm/engagements/{id}
Integrations supported
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
Path parameters ​
The ID of the resource.
23423523
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.
unified
raw
normalized
unified
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
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
call
email
meeting
Required in
- Salesforce
- Zoho CRM
Supported in
- HubSpot
The contact's unique identifier. Required when engagement_type is email.
Supported in
- Zoho CRM
Response Body ​
The engagement's unique identifier
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's owner
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The owner's unique identifier
The engagement's content
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's subject
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's direction
Supported in
- HubSpot
The engagement's type - call, email, meeting or raw response
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's start time
Supported in
- HubSpot
- Salesforce
- Zoho CRM
The engagement's end time
Supported in
- HubSpot
- Salesforce
- Zoho CRM
The engagement's account
Supported in
- HubSpot
- Pipedrive
- Salesforce
The account's unique identifier
The engagement's contacts
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The contact's unique identifier
The engagement's opportunity
Supported in
- HubSpot
- Pipedrive
The opportunity's unique identifier
The date and time of the engagement's creation
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
The date and time of the engagement's last update
Supported in
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
Raw data returned from the remote API call.