Skip to content

List Leads

Endpoint

http
GET /unified/crm/leads
Integrations supported
  • Copper
  • Pipedrive
  • Salesforce
  • Zoho CRM

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. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
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_limit
boolean
Ignores the `limit` query parameter.
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.
Example: remote_query[foo]=bar
owner
object
The owner of the lead
Supported in
  • Copper
  • Pipedrive
  • Salesforce
id
string
The lead's owner's unique identifier
contact
object
The contact associated with the lead
Supported in
  • Pipedrive
id
string
The contact's unique identifier
organization
Supported in
  • Pipedrive
account
object
The lead's account
Supported in
  • Salesforce
id
string
The account's unique identifier
name
string
The name of the lead
Supported in
  • Copper
  • Salesforce
country
string
The country of the lead
Supported in
  • Copper
  • Salesforce
state
Supported in
  • Salesforce
lead_source
string
The lead's source
Supported in
  • Salesforce
created_at
string · date-time
The date and time of the lead's creation
Supported in
  • Copper
  • Salesforce
updated_at
string · date-time
The date and time of the lead's last update
Supported in
  • Copper
  • Salesforce
converted_at
object · date-time
The date and time of the lead's conversion
Supported in
  • Salesforce
email_addresses
array
Supported in
  • Copper
  • Salesforce
include_custom_fields
Supported in
  • Salesforce
custom_fields
Supported in
  • Salesforce

Response Body

result
object[]
List of Leads
id
string
REQUIRED · The lead' unique identifier
Supported in
  • Copper
  • Pipedrive
  • Salesforce
  • Zoho CRM
owner
object
The lead's owner
Supported in
  • Copper
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string
The lead's owner's unique identifier
lead_source
string
The lead's source
Supported in
  • Pipedrive
  • Salesforce
  • Zoho CRM
title
string
The lead's title
Supported in
  • Copper
  • Pipedrive
  • Salesforce
  • Zoho CRM
contact
object
The contact associated with the lead
Supported in
  • Pipedrive
id
string
The contact's unique identifier
account
object
The lead's account
Supported in
  • Pipedrive
  • Salesforce
id
string
The account's unique identifier
first_name
string
The lead's first name
Supported in
  • Copper
  • Salesforce
  • Zoho CRM
last_name
string
The lead's last name
Supported in
  • Copper
  • Salesforce
  • Zoho CRM
addresses
object[]
Supported in
  • Copper
  • Salesforce
  • 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
  • Salesforce
  • Zoho CRM
email
string
The email address
type
string
The email address type
phone_numbers
object[]
Supported in
  • Copper
  • Salesforce
  • Zoho CRM
number
string
The phone number
extension
string
The extension of the phone number
type
string
The phone number type
last_activity_at
string · date-time
The date and time of the lead's last activity
Supported in
  • Zoho CRM
created_at
string · date-time
The date and time of the lead's creation
Supported in
  • Copper
  • Pipedrive
  • Salesforce
  • Zoho CRM
updated_at
string · date-time
The date and time of the lead's last update
Supported in
  • Copper
  • Pipedrive
  • Salesforce
  • Zoho CRM
converted_at
string · date-time
The date and time of the lead's conversion
Supported in
  • Salesforce
converted_contact
string
The lead's converted contact
Supported in
  • Salesforce
converted_account
string
The lead's converted account
Supported in
  • Salesforce
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
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.