List Engagements ​
Endpoint ​
http
GET /unified/crm/engagements
Integrations supported
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
Query parameters ​
integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example:
62f44730-dd91-461e-bd6a-aedd9e0ad79d
account_id
string
The account's unique identifier
Supported in
- Close
contact_id
string
Integration specific notes
- CloseThe contact's unique identifier
- 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
- SalesforceThe contact's unique identifier
- Zoho CRMThe contact's unique identifier. Required when engagement_type is email.
Required in
- Outreach
Supported in
- Close
- HubSpot
- Salesforce
- Zoho CRM
owner_id
string
The user's unique identifier
Supported in
- Close
engagement_type
string
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_id is also present.
- HubSpotThe engagement's type. Required unless contact_id is also present. If specifying contact_id, this shouldn't be specified.
All possible enum values:
call
email
meeting
Required in
- Salesforce
- Zoho CRM
Supported in
- Close
- HubSpot
Response Body ​
result
object[]
List of Engagements
id
string
REQUIRED · The engagement's unique identifier
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
owner
string
The engagement's owner
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
content
string
The engagement's content
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
subject
string
The engagement's subject
Supported in
- Close
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
direction
string
The engagement's direction
Supported in
- Close
- HubSpot
- Outreach
engagement_type
string
The engagement's type - call, email, meeting or raw response
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
start_time
string · date-time
The engagement's start time
Supported in
- Close
- HubSpot
- Salesforce
- Zoho CRM
end_time
string · date-time
The engagement's end time
Supported in
- Close
- HubSpot
- Salesforce
- Zoho CRM
account
string
The engagement's account
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Pipedrive
- Salesforce
contact
string[]
The engagement's contact
Supported in
- Close
- Copper
- HubSpot
- Outreach
- Salesforce
- Zoho CRM
opportunity
string[]
The engagement's opportunity
Supported in
- Copper
- HubSpot
created_at
string · date-time
The date and time of the engagement's creation
Supported in
- Copper
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
updated_at
string · date-time
The date and time of the engagement's last update
Supported in
- Copper
- Outreach
- Pipedrive
- Salesforce
- Zoho CRM
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
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.