Appearance

Get Engagements ​

Endpoint ​

http
GET /unified/crm/engagements/{id}
Integrations supported
  • Affinity
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • 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
  • KeapThe engagement's type
All possible enum values:
  • call
  • email
  • meeting
  • task
Enum support by integration
  • Close
    • call
  • HubSpot
    • call
    • email
    • meeting
  • Salesforce
    • call
    • email
    • meeting
  • Zoho CRM
    • call
    • email
    • meeting
  • Affinity
    • call
    • email
    • meeting
  • Teamleader
    • call
    • meeting
    • task
  • Pipeliner
    • call
    • email
  • Keap
    • email
    • meeting
Required in
  • Affinity
  • Close
  • Keap
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zoho CRM
Supported in
  • HubSpot
contact_id
string

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

Supported in
  • Zoho CRM
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
  • updated_at
Supported in
  • Pipeliner
content
string

Set this value only when engagement type is email.

Supported in
  • Pipeliner
subject
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
created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • Pipeliner
updated_at
string · date-time

The date and time of the engagement's last update

Supported in
  • Pipeliner
status
string

The engagement's status

Supported in
  • Pipeliner
account
object

The engagement's account

Supported in
  • Pipeliner
id
string

The account's unique identifier

contact
array

The engagement's contacts

Supported in
  • Pipeliner

Response Body ​

id
string
REQUIRED · 

The engagement's unique identifier

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

The engagement's owner

Supported in
  • Affinity
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Keap
  • 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
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Zoho CRM
subject
string

The engagement's subject

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

The engagement's direction

Supported in
  • Close
  • HubSpot
  • Pipeliner
  • Zoho CRM
engagement_type
string

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

Supported in
  • Affinity
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Keap
  • Nutshell
  • 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
  • Pipeliner
  • Planhat
  • Teamleader
start_time
string · date-time

The engagement's start time

Supported in
  • Affinity
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • 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
  • HubSpot
  • Keap
  • Nutshell
  • 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
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
  • Zoho CRM
id
string

The account's unique identifier

contact
object[]

The engagement's contacts

Supported in
  • Affinity
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Keap
  • Nutshell
  • 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
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Pipedrive
  • Pipeliner
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The opportunity's unique identifier

lead
object[]

The engagement's lead

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

The lead's unique identifier

phone_numbers
object[]
Supported in
  • 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
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • 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
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
remote_data
object

Raw data returned from the remote API call.