Skip to content
GET /unified/crm/engagements

Query Parameters

Refer Specifying query parameters in Truto APIs

engagement_typestring

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

Possible values:
callchatemailmeetingtask
21 supported10 required5 notes
Affinity
required
callemailmeetingchat
Freshsales
required
emailmeeting
Highlevel
required
callemailchatmeeting
Keap
required
emailmeeting

The engagement's type

Monday CRM
required
callmeeting
OnePageCRM
required
callmeeting
Pipeliner
required
callemail
Salesforce
required
callemailmeeting

The engagement's type

Teamleader
required
callmeetingtask
Zoho CRM
required
callemailmeeting
Close
supported
callemailmeeting

The engagement's type - call, email, meeting or raw type. Applicable only when account is also present.

Copper
supported
callmeeting

The engagement's type

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
Microsoft Dynamics 365 Sales
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
start_timestring · date-time

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

14 supported1 required
Affinity
required
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
end_timestring · date-time

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

12 supported1 required
Affinity
required
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Outreach
supported
Salesforce
supported
Zoho CRM
supported
contactobject[]

The engagement's contacts

References: Contacts → id
20 supported3 notes
Close
supported

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

Freshsales
supported

Contact associated with the engagement. Required when engagement_type is email.

Highlevel
supported

Contact is required when engagement_type is meeting.

Affinity
supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The contact's unique identifier

opportunityobject[]

The engagement's opportunity

11 supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The opportunity's unique identifier

accountobject

Filter based on the account of the engagements

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

The account's unique identifier

ownerobject

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

18 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The owner's unique identifier

created_atstring · date-time

The date and time of the engagement's creation

17 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
activity_date
1 supported
Copper
supported
subjectstring

Set this value only when engagement type is email.

18 supported
Affinity
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
description
1 supported
Microsoft Dynamics 365 Sales
supported
leadobject[]

Lead associated with the engagement

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
required·

The unique identifier for the lead.

statusstring

The engagement's status

10 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Highlevel
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Planhat
supported
Teamleader
supported
updated_atstring · date-time

The date and time of the engagement's last update

15 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
contact_idstring
3 supported1 required3 notes
Outreach
required

The contact's unique identifier

HubSpot
supported

The contact's unique identifier. Required unless engagement_type is also present. If specifying engagement_type, this shouldn't be specified.

Zoho CRM
supported

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

engagement_type_idstring

The engagement type's unique identifier

1 supported
Nutshell
supported
sort_by
Possible values:
created_atend_timesubjectupdated_at
3 supported
OnePageCRM
supported
created_atupdated_at
Pipeliner
supported
created_atupdated_at
Planhat
supported
subjectcreated_atend_time
contentstring

Set this value only when engagement type is email.

18 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
directionstring

Set this value only when engagement type is email.

7 supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Outreach
supported
Pipeliner
supported
Zoho CRM
supported
user_idstring
1 supported
Wix
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_key_bystring

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_limitboolean

Ignores the limit query parameter.

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

next_cursorstring

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.

resultobject[]

List of Engagements

idstring
required·

The engagement's unique identifier

21 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
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
14 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zoho CRM
supported
1 property
idstring

The account's unique identifier

contactobject[]

The engagement's contacts

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

The contact's unique identifier

contentstring

The engagement's content

18 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
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

17 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
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

7 supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Outreach
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

12 supported
Affinity
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Outreach
supported
Salesforce
supported
Zoho CRM
supported
engagement_typestring

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

21 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
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
1 property
idstring

The lead's unique identifier

notesobject[]

The engagement's notes

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

The note's unique identifier

opportunityobject[]

The engagement's opportunity

11 supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
1 property
idstring

The opportunity's unique identifier

ownerobject

The engagement's owner

18 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
1 property
idstring

The owner's unique identifier

phone_numbersobject[]
4 supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Zendesk Sell
supported
4 properties
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
1 property
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

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

The engagement's status

10 supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Highlevel
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Planhat
supported
Teamleader
supported
subjectstring

The engagement's subject

18 supported
Affinity
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Outreach
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

15 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
curl -X GET 'https://api.truto.one/unified/crm/engagements?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?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"
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.list(
  'crm',
  'engagements',
  { 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():
    async for item in truto_api.unified_api.list(
        "crm",
        "engagements",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())