Appearance

List Engagements ​

Endpoint ​

http
GET /unified/crm/engagements
Integrations supported
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM

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_key_by
string

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.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
account
object

Filter based on the account of the engagements

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Pipeliner
  • Planhat
  • Salesforce
id
string
REQUIRED · 

The account's unique identifier

contact
array

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.
  • HighlevelContact is required when engagement_type is meeting.
Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • Keap
  • Pipeliner
  • Salesforce
  • Wix
  • Zendesk Sell
owner
object

Filter based on the owner of the engagements. Applicable only when account is also present.

Supported in
  • Close
  • Microsoft Dynamics 365 Sales
  • Pipedrive
id
string
REQUIRED · 

The owner's unique identifier

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 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
  • KeapThe engagement's type
All possible enum values:
  • call
  • chat
  • email
  • meeting
  • task
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
  • Affinity
    • call
    • email
    • meeting
    • chat
  • Teamleader
    • call
    • meeting
    • task
  • Pipeliner
    • call
    • email
  • Keap
    • email
    • meeting
  • Highlevel
    • call
    • email
    • chat
    • meeting
Required in
  • Affinity
  • Freshsales
  • Highlevel
  • Keap
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zoho CRM
Supported in
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Pipedrive
created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • Close
  • Microsoft Dynamics 365 Sales
  • Pipeliner
  • Salesforce
activity_date
Supported in
  • Copper
contact_id
string
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
subject
string

Set this value only when engagement type is email.

Supported in
  • Microsoft Dynamics 365 Sales
  • Nutshell
  • Pipeliner
  • Salesforce
lead
array

Lead associated with the engagement

Supported in
  • Microsoft Dynamics 365 Sales
  • Salesforce
  • Zendesk Sell
updated_at
string · date-time

The date and time of the engagement's last update

Supported in
  • Microsoft Dynamics 365 Sales
  • Pipeliner
  • Salesforce
opportunity
array

The engagement's opportunity

Supported in
  • Capsule
  • Microsoft Dynamics 365 Sales
start_time
string · date-time

The start_time of the engagements. Must be before the end_time and date range should not exceed one year

Required in
  • Affinity
end_time
string · date-time

The end_time of the engagements. Must be after the start_time and date range should not exceed one year

Required in
  • Affinity
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • end_time
  • subject
  • updated_at
Enum support by integration
  • Planhat
    • subject
    • created_at
    • end_time
  • Pipeliner
    • created_at
    • updated_at
Supported in
  • Pipeliner
  • Planhat
user_id
string
Supported in
  • Wix
description
Supported in
  • Microsoft Dynamics 365 Sales
status
string

The engagement's status

Supported in
  • Microsoft Dynamics 365 Sales
  • Pipeliner
content
string

Set this value only when engagement type is email.

Supported in
  • Pipeliner
direction
string

Set this value only when engagement type is email.

Supported in
  • Pipeliner
engagement_type_id
string

The engagement type's unique identifier

Supported in
  • Nutshell

Response Body ​

result
object[]

List of Engagements

id
string
REQUIRED · 

The engagement's unique identifier

Supported in
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
owner
object

The engagement's owner

Supported in
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The owner's unique identifier

content
string

The engagement's content

Supported in
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Zoho CRM
subject
string

The engagement's subject

Supported in
  • Affinity
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
direction
string

The engagement's direction

Supported in
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipeliner
  • Zoho CRM
engagement_type
string

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

Supported in
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
internal_notes
string

The engagement's internal notes

Supported in
  • HubSpot
notes
object[]

The engagement's notes

Supported in
  • Affinity
  • Nutshell
id
string

The note's unique identifier

status
string

The engagement's status

Supported in
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • Outreach
  • Pipeliner
  • Planhat
  • Teamleader
start_time
string · date-time

The engagement's start time

Supported in
  • Affinity
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
end_time
string · date-time

The engagement's end time

Supported in
  • Affinity
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Salesforce
  • Zoho CRM
duration
string

The engagement's duration

Supported in
  • Microsoft Dynamics 365 Sales
  • Nutshell
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
project
object

The engagement's project

Supported in
  • Capsule
  • Teamleader
id
string

The project's unique identifier

account
object

The engagement's account

Supported in
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
id
string

The account's unique identifier

contact
object[]

The engagement's contacts

Supported in
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
id
string

The contact's unique identifier

opportunity
object[]

The engagement's opportunity

Supported in
  • Capsule
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Outreach
  • Pipedrive
  • Pipeliner
  • Teamleader
  • Zendesk Sell
id
string

The opportunity's unique identifier

lead
object[]

The engagement's lead

Supported in
  • Microsoft Dynamics 365 Sales
  • Nutshell
  • Pipeliner
  • Salesforce
  • Zendesk Sell
id
string

The lead's unique identifier

phone_numbers
object[]
Supported in
  • Outreach
  • Pipeliner
  • Zendesk Sell
id
string

The unique identifier of the phone number

number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

custom_fields
object

All the custom fields present on the engagement

Supported in
  • Planhat
created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Zoho CRM
updated_at
string · date-time

The date and time of the engagement's last update

Supported in
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • 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.