Skip to content
GET /unified/crm/engagements/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

engagement_typestring

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

Possible values:
callemailmeetingnotetask
18 supported8 required3 notes
Affinity
required
callemailmeeting
Close
required
callmeetingnoteemail
Keap
required
emailmeeting

The engagement's type

OnePageCRM
required
callmeeting
Pipeliner
required
callemail
Salesforce
required
callemailmeeting

The engagement's type

Teamleader
required
callmeetingtask
Zoho CRM
required
callemailmeeting
HubSpot
supported
callemailmeeting

The engagement's type. Required unless contact_id is also present. If specifying contact_id, this shouldn't be specified.

Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Nutshell
supported
Pipedrive
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
sort_by
Possible values:
created_atupdated_at
1 supported
Pipeliner
supported
contentstring

Set this value only when engagement type is email.

15 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
subjectstring

Set this value only when engagement type is email.

15 supported
Affinity
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
directionstring

Set this value only when engagement type is email.

4 supported
Close
supported
HubSpot
supported
Pipeliner
supported
Zoho CRM
supported
created_atstring · date-time

The date and time of the engagement's creation

14 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the engagement's last update

12 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
statusstring

The engagement's status

7 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
Teamleader
supported
accountobject

The engagement's account

References: Accounts → id
13 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
idstring

The account's unique identifier

contactobject[]

The engagement's contacts

References: Contacts → id
18 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The contact's unique identifier

contact_idstring

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

1 supported
Zoho CRM
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Response Body

idstring
required·

The engagement's unique identifier

18 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
accountobject

The engagement's account

References: Accounts → id
13 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
idstring

The account's unique identifier

contactobject[]

The engagement's contacts

References: Contacts → id
18 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The contact's unique identifier

contentstring

The engagement's content

15 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
created_atstring · date-time

The date and time of the engagement's creation

14 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
custom_fieldsRecord<string, any>

All the custom fields present on the engagement

1 supported
Planhat
supported
directionstring

The engagement's direction

4 supported
Close
supported
HubSpot
supported
Pipeliner
supported
Zoho CRM
supported
durationstring

The engagement's duration

7 supported
Microsoft Dynamics 365 Sales
supported
Nutshell
supported
OnePageCRM
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
end_timestring · date-time

The engagement's end time

9 supported
Affinity
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
Salesforce
supported
Zoho CRM
supported
engagement_typestring

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

18 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
internal_notesstring

The engagement's internal notes

1 supported
HubSpot
supported
leadobject[]

The engagement's lead

References: Leads → id
7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Nutshell
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The lead's unique identifier

notesobject[]

The engagement's notes

References: Notes → id
2 supported
Affinity
supported
Nutshell
supported
idstring

The note's unique identifier

opportunityobject[]

The engagement's opportunity

10 supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Pipedrive
supported
Pipeliner
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The opportunity's unique identifier

ownerobject

The engagement's owner

15 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The owner's unique identifier

phone_numbersobject[]
3 supported
OnePageCRM
supported
Pipeliner
supported
Zendesk Sell
supported
extensionstring

The extension of the phone number

idstring

The unique identifier of the phone number

numberstring

The phone number

typestring

The phone number type

projectobject

The engagement's project

References: Projects → id
2 supported
Capsule
supported
Teamleader
supported
idstring

The project's unique identifier

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_timestring · date-time

The engagement's start time

12 supported
Affinity
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
statusstring

The engagement's status

7 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
Teamleader
supported
subjectstring

The engagement's subject

15 supported
Affinity
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the engagement's last update

12 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
curl -X GET 'https://api.truto.one/unified/crm/engagements/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/crm/engagements/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/crm/engagements/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.get(
  'crm',
  'engagements',
  '<resource_id>',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.get(
        "crm",
        "engagements",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())