Appearance

Get Leads ​

Endpoint ​

http
GET /unified/crm/leads/{id}
Integrations supported
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • 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 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
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
fields
Supported in
  • Monday CRM
  • Zoho CRM

Response Body ​

id
string
REQUIRED · 

The lead' unique identifier

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
owner
object

The lead's owner

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The lead's owner's unique identifier

lead_source
string

The lead's source

Supported in
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
lead_type
string

The lead's type

Supported in
  • HubSpot
status
string

The lead's status

Supported in
  • HubSpot
  • Monday CRM
  • Nutshell
  • Zendesk Sell
  • Zoho CRM
title
string

The lead's title

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
contact
object

The contact associated with the lead

References: Contacts → id
Supported in
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Zoho CRM
id
string

The contact's unique identifier

account
object

The lead's account

References: Accounts → id
Supported in
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zoho CRM
id
string

The account's unique identifier

first_name
string

The lead's first name

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
last_name
string

The lead's last name

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
addresses
object[]
Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
street_1
string

Line 1 of the street address

street_2
string

Line 2 of the street address

city
string

The city

state
string

The state

postal_code
string

The postal code

country
string

The country

type
string

The address type

email_addresses
object[]
Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • Insightly
  • Monday CRM
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
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 lead

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
last_activity_at
string · date-time

The date and time of the lead's last activity

Supported in
  • HubSpot
  • Insightly
  • Nutshell
  • Salesforce
  • Zoho CRM
created_at
string · date-time

The date and time of the lead's creation

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
updated_at
string · date-time

The date and time of the lead's last update

Supported in
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
converted_at
string · date-time

The date and time of the lead's conversion

Supported in
  • Insightly
  • Pipeliner
  • Salesforce
converted_contact
string

The lead's converted contact

Supported in
  • Insightly
  • Salesforce
converted_account
string

The lead's converted account

Supported in
  • Insightly
  • Salesforce
urls
object[]

The lead's urls

Supported in
  • Monday CRM
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
url
string

The lead's URL

type
string

The lead's URL type

remote_data
object

Raw data returned from the remote API call.