Skip to content
GET /unified/crm/leads

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

Query Parameters

Refer Specifying query parameters in Truto APIs

namestring

The name of the lead

3 supported
Copper
supported
Pipeliner
supported
Salesforce
supported
ownerobject

The lead's owner

11 supported2 notes
Copper
supported

The owner of the lead

Pipedrive
supported

The owner of the leads. This filter is mutually exclusive to other filters. If this filter is used, other should not be used.

Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The lead's owner's unique identifier

countrystring

The country of the lead

4 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Salesforce
supported
Zoho CRM
supported
email_addressesobject[]
8 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
emailstring

The email address

typestring

The email address type

created_atstring · date-time

The date and time of the lead's creation

11 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the lead's last update

10 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
first_namestring

The lead's first name

7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
last_namestring

The lead's last name

7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
titlestring

The lead's title

10 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
contactobject[]

The contact associated with the lead

References: Contacts → id
6 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zoho CRM
supported
idstring
required·

The contact's unique identifier

idstring
required
accountobject

The lead's account

References: Accounts → id
7 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zoho CRM
supported
idstring
required·

The account's unique identifier

phone_numbersobject[]
7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Monday CRM
supported
Salesforce
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

city
2 supported
Microsoft Dynamics 365 Sales
supported
Zoho CRM
supported
state
3 supported
Microsoft Dynamics 365 Sales
supported
Salesforce
supported
Zoho CRM
supported
postal_code
1 supported
Microsoft Dynamics 365 Sales
supported
search_term
5 supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Salesforce
supported
Zoho CRM
supported
lead_sourcestring

The lead's source

9 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
lead_typestring

The lead's type

1 supported
HubSpot
supported
statusstring

The lead's status

Possible values:
attempted to contactcancelledcontactedlostnewnew leadopenpendingqualifiedunqualifiedwonworking
5 supported
Monday CRM
supported
attempted to contactnew leadcontactedunqualifiedqualified
Nutshell
supported
openpendingwonlostcancelled
Zendesk Sell
supported
newworkingunqualified
HubSpot
supported
Zoho CRM
supported
fields
4 supported
HubSpot
supported
Monday CRM
supported
Salesforce
supported
Zoho CRM
supported
sort_by
Possible values:
created_atemail_addressesfirst_namelast_namenameownertitleupdated_at
5 supported
Nutshell
supported
created_at
Pipedrive
supported
titleownercreated_atupdated_at
Pipeliner
supported
created_atupdated_atname
Zendesk Sell
supported
first_namelast_nameemail_addressescreated_atupdated_at
Zoho CRM
supported
created_atupdated_atcreated_atupdated_at
description
1 supported
Pipeliner
supported
last_activity_atstring · date-time

The date and time of the lead's last activity

5 supported
HubSpot
supported
Insightly
supported
Nutshell
supported
Salesforce
supported
Zoho CRM
supported
converted_atobject · date-time

The date and time of the lead's conversion

3 supported
Insightly
supported
Pipeliner
supported
Salesforce
supported
custom_fieldsRecord<string, any>

All the custom fields present on the lead

7 supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
addressesobject[]
6 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
citystring

The city

countrystring

The country

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

industry
1 supported
Zoho CRM
supported
website
1 supported
Zoho CRM
supported
number_of_employees
1 supported
Zoho CRM
supported
account_id
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_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 Leads

idstring
required·

The lead' unique identifier

11 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
accountobject

The lead's account

References: Accounts → id
7 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zoho CRM
supported
1 property
idstring

The account's unique identifier

addressesobject[]
6 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
7 properties
citystring

The city

countrystring

The country

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

contactobject

The contact associated with the lead

References: Contacts → id
6 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zoho CRM
supported
1 property
idstring

The contact's unique identifier

converted_accountstring

The lead's converted account

2 supported
Insightly
supported
Salesforce
supported
converted_atstring · date-time

The date and time of the lead's conversion

3 supported
Insightly
supported
Pipeliner
supported
Salesforce
supported
converted_contactstring

The lead's converted contact

2 supported
Insightly
supported
Salesforce
supported
created_atstring · date-time

The date and time of the lead's creation

11 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
custom_fieldsRecord<string, any>

All the custom fields present on the lead

7 supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
email_addressesobject[]
8 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
2 properties
emailstring

The email address

typestring

The email address type

first_namestring

The lead's first name

7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
last_activity_atstring · date-time

The date and time of the lead's last activity

5 supported
HubSpot
supported
Insightly
supported
Nutshell
supported
Salesforce
supported
Zoho CRM
supported
last_namestring

The lead's last name

7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
lead_sourcestring

The lead's source

9 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
lead_typestring

The lead's type

1 supported
HubSpot
supported
ownerobject

The lead's owner

11 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
1 property
idstring

The lead's owner's unique identifier

phone_numbersobject[]
7 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Monday CRM
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
3 properties
extensionstring

The extension 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.

statusstring

The lead's status

5 supported
HubSpot
supported
Monday CRM
supported
Nutshell
supported
Zendesk Sell
supported
Zoho CRM
supported
titlestring

The lead's title

10 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the lead's last update

10 supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Pipedrive
supported
Pipeliner
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
urlsobject[]

The lead's urls

5 supported
Monday CRM
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
2 properties
typestring

The lead's URL type

urlstring

The lead's URL

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

asyncio.run(main())