List Engagements ​
Endpoint ​
GET /unified/crm/engagements
Integrations supported
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
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
By default the result
attribute is an array of objects. This parameter allows you to specify a field in each result
objects to use as key, which transforms the result
array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
id
Ignores the limit
query parameter.
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
Filter based on the account of the engagements
Supported in
- Close
- Salesforce
The account's unique identifier
The engagement's contacts
Integration specific notes
- CloseFilter based on the contact of the engagements. Applicable only when account is also present.
- FreshSalesContact associated with the engagement. Required when engagement_type is email.
Supported in
- Close
- FreshSales
- Salesforce
Filter based on the owner of the engagements. Applicable only when account is also present.
Supported in
- Close
- Pipedrive
The owner's unique identifier
The engagement's type - call, email, meeting or raw response
Integration specific notes
- CloseThe engagement's type - call, email, meeting or raw type. Applicable only when account is also present.
- CopperThe engagement's type
- 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
Enum support by integration
- Close
call
email
meeting
- Copper
call
meeting
- HubSpot
call
email
meeting
- Salesforce
call
email
meeting
- Zoho CRM
call
email
meeting
- FreshSales
email
meeting
Required in
- FreshSales
- Salesforce
- Zoho CRM
Supported in
- Close
- Copper
- HubSpot
- Pipedrive
The date and time of the engagement's creation
Supported in
- Close
- Salesforce
Supported in
- Copper
Integration specific notes
- HubSpotThe contact's unique identifier. Required unless engagement_type is also present. If specifying engagement_type, this shouldn't be specified.
- OutreachThe contact's unique identifier
- Zoho CRMThe contact's unique identifier. Required when engagement_type is email.
Required in
- Outreach
Supported in
- HubSpot
- Zoho CRM
The engagement's subject
Supported in
- Salesforce
The date and time of the engagement's last update
Supported in
- Salesforce
Response Body ​
List of Engagements
The engagement's unique identifier
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's owner
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The owner's unique identifier
The engagement's content
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's subject
Supported in
- Close
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's direction
Supported in
- Close
- FreshSales
- HubSpot
- Outreach
The engagement's type - call, email, meeting or raw response
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The engagement's start time
Supported in
- Close
- FreshSales
- HubSpot
- Salesforce
- Zoho CRM
The engagement's end time
Supported in
- Close
- FreshSales
- HubSpot
- Salesforce
- Zoho CRM
The engagement's account
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
The account's unique identifier
The engagement's contacts
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The contact's unique identifier
The engagement's opportunity
Supported in
- Copper
- HubSpot
- Pipedrive
The opportunity's unique identifier
The date and time of the engagement's creation
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
The date and time of the engagement's last update
Supported in
- Close
- Copper
- FreshSales
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
Raw data returned from the remote API call.
The cursor to use for the next page of results. Pass this value as next_cursor
in the query parameter in the next request to get the next page of results.