Skip to content

List Contacts

Endpoint

http
GET /unified/crm/contacts
Integrations supported
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • FreshSales
  • HubSpot

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

Defaults to unified.

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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
name
string

The contact's full name

Supported in
  • Close
  • Copper
  • Pipedrive
  • Salesforce
first_name
string

The contact's first name

Supported in
  • Accelo
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
last_name
string

The contact's last name

Supported in
  • Accelo
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
email_addresses
array
Supported in
  • Accelo
  • ActiveCampaign
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Salesforce
phone_numbers
array
Supported in
  • Accelo
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
account
object

The contact's account

Supported in
  • Close
  • Copper
  • HubSpot
  • Salesforce
id
string

The account's unique identifier

name
string

The account's name

country
string

The country of the contacts

Supported in
  • Copper
  • HubSpot
  • Salesforce
city
string

The city of the contacts

Supported in
  • Copper
  • HubSpot
  • Salesforce
state
string

The state of the contacts

Supported in
  • Copper
  • HubSpot
  • Salesforce
updated_at
string · date-time

The date and time of the contact's last update

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Copper
  • HubSpot
  • Salesforce
view
object

The view you want to get the contacts from

Supported in
  • HubSpot
id
string

The unique identifier of the views

include_custom_fields
Supported in
  • Salesforce
custom_fields
Supported in
  • Salesforce
view_id
string

The view id of the contacts

Supported in
  • FreshSales
search_term

Search by name, email, phone, account

Supported in
  • ActiveCampaign
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • email_addresses
  • id
  • name
Supported in
  • ActiveCampaign

Response Body

result
object[]

List of Contacts

id
string
REQUIRED · 

The contact's unique identifier

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
first_name
string

The contact's first name

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
last_name
string

The contact's last name

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
name
string

The contact's full name

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
title
string

The contact's job title

Supported in
  • Accelo
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Zoho CRM
account
object

The contact's account

Supported in
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string

The account's unique identifier

name
string

The account's name

addresses
object[]
Supported in
  • Capsule
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • 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
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

tags
object[]

The contact's tags

Supported in
  • Capsule
  • Copper
  • FreshSales
  • Highlevel
  • Zoho CRM
id
string

The tag's unique identifier

name
string

The tag's name

last_activity_at
string · date-time

The date and time of the contact's last activity

Supported in
  • Accelo
  • Capsule
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
updated_at
string · date-time

The date and time of the contact's last update

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
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.