Skip to content
GET /unified/crm/contacts

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

email_addressesobject[]
26 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
emailstring
required·

The email address

idstring

The unique identifier of the email addresses

typestring

The email address type

phone_numbersobject[]
25 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
numberstring
required·

The phone number

typestring
required·

The phone number type

Possible values:
mobilework
extensionstring

The extension of the phone number

idstring

The unique identifier of the phone number

created_atstring · date-time

The date and time of the contact's creation

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the contact's last update

23 supported
Accelo
supported
ActiveCampaign
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
first_namestring

The contact's first name

25 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
last_namestring

The contact's last name

25 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
search_term

Search by name, email, phone, account

13 supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Highlevel
supported
HubSpot
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Salesflare
supported
Salesforce
supported
Zoho CRM
supported
sort_byobject

Sort results by one or more fields

Possible values:
created_atemail_addressesfirst_nameidlast_activity_atlast_namenametitleupdated_at
19 supported
ActiveCampaign
supported
created_atidnameemail_addresses
Copper
supported
namecreated_atupdated_atlast_activity_at
Freshsales
supported
namecreated_atupdated_atlast_activity_at
Highlevel
supported
first_namelast_nameemail_addressesupdated_atcreated_at
Keap
supported
created_atlast_activity_atfirst_nameemail_addresses
Nutshell
supported
name
OnePageCRM
supported
created_atupdated_atnamefirst_namelast_name
Outreach
supported
first_namelast_namecreated_atupdated_at
Pipeliner
supported
created_atupdated_atfirst_namelast_name
Planhat
supported
namecreated_atupdated_attitle
Teamleader
supported
namecreated_atupdated_at
Wix
supported
titlefirst_namelast_namecreated_atlast_activity_atemail_addresses
Zendesk Sell
supported
first_namelast_nameemail_addressescreated_atupdated_atname
Attio
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
Zoho CRM
supported
created_atstring · date-time

The date and time of the contact's creation

Possible values:
ascdesc
6 supported
Attio
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the contact's last update

Possible values:
ascdesc
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Pipedrive
supported
Salesforce
supported
Zoho CRM
supported
namestring

The contact's full name

25 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
last_activity_atstring · date-time

The date and time of the contact's last activity

13 supported
Accelo
supported
Affinity
supported
Capsule
supported
Copper
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Outreach
supported
Planhat
supported
Salesforce
supported
Wix
supported
Zoho CRM
supported
titlestring

The contact's job title

19 supported
Accelo
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
accountobject

The contact's account

References: Accounts → id
22 supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The account's unique identifier

namestring
required·

The account's name

required
ownerobject

The account's owner

9 supported
Highlevel
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
idstring
required·

The owner's unique identifier

tagsobject[]

The contact's tags

13 supported
Capsule
supported
Copper
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Salesflare
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The tag's unique identifier

namestring
required·

The tag's name

addressesobject[]
19 supported
Attio
supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
citystring

The city

countrystring

The country

idstring

The unique identifier of the address

postal_codestring

The postal code

statestring

The state

street_1string

Line 1 of the street address

street_2string

Line 2 of the street address

typestring

The address type

countrystring

The country of the contacts

5 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
Zoho CRM
supported
citystring

The city of the contacts

5 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
Zoho CRM
supported
statestring

The state of the contacts

5 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Salesforce
supported
Zoho CRM
supported
postal_code
2 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
view_idstring

The view id of the contacts

1 supported
Freshsales
supported
workspaceobject

The workspace associated with the contact.

1 supported1 required
Highlevel
required
idstring

The workspace's unique identifier

viewobject

The view you want to get the contacts from

1 supported
HubSpot
supported
idstring

The unique identifier of the views

opportunitiesobject[]

The opportunities associated with the contacts.

1 supported
HubSpot
supported
idstring
required
fields
4 supported
HubSpot
supported
Monday CRM
supported
Salesforce
supported
Zoho CRM
supported
last_updated
1 supported
Keap
supported
custom_fieldsRecord<string, any>

All the custom fields present on the contact

18 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Zendesk Sell
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_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 Contacts

idstring
required·

The contact's unique identifier

26 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
accountobject

The contact's account

References: Accounts → id
22 supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
2 properties
idstring

The account's unique identifier

namestring

The account's name

addressesobject[]
19 supported
Attio
supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
8 properties
citystring

The city

countrystring

The country

idstring

The unique identifier of the address

postal_codestring

The postal code

statestring

The state

street_1string

Line 1 of the street address

street_2string

Line 2 of the street address

typestring

The address type

created_atstring · date-time

The date and time of the contact's creation

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
custom_fieldsRecord<string, any>

All the custom fields present on the contact

18 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
email_addressesobject[]
26 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
3 properties
emailstring

The email address

idstring

The unique identifier of the email addresses

typestring

The email address type

etagstring

The unique identifier for the specific version of the resource.

2 supported
Pipeliner
supported
Wix
supported
first_namestring

The contact's first name

25 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
last_activity_atstring · date-time

The date and time of the contact's last activity

13 supported
Accelo
supported
Affinity
supported
Capsule
supported
Copper
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Outreach
supported
Planhat
supported
Salesforce
supported
Wix
supported
Zoho CRM
supported
last_namestring

The contact's last name

25 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
namestring

The contact's full name

25 supported
Accelo
supported
ActiveCampaign
supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
ownerobject

The account's owner

9 supported
Highlevel
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Salesflare
supported
Zendesk Sell
supported
1 property
idstring

The owner's unique identifier

phone_numbersobject[]
25 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
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

remote_dataRecord<string, any>

Raw data returned from the remote API call.

tagsobject[]

The contact's tags

13 supported
Capsule
supported
Copper
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Salesflare
supported
Teamleader
supported
Zendesk Sell
supported
Zoho CRM
supported
2 properties
idstring

The tag's unique identifier

namestring

The tag's name

titlestring

The contact's job title

19 supported
Accelo
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
Salesforce
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the contact's last update

23 supported
Accelo
supported
ActiveCampaign
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
urlsobject[]

The contact's urls

9 supported
Attio
supported
Close
supported
Highlevel
supported
Monday CRM
supported
OnePageCRM
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
2 properties
typestring

The contact's URL type

urlstring

The contact's URL

curl -X GET 'https://api.truto.one/unified/crm/contacts?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/contacts?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/contacts"
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',
  'contacts',
  { 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",
        "contacts",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())