Appearance

List Accounts ​

Endpoint ​

http
GET /unified/crm/accounts
Integrations supported
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • 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.

  • 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 name of the account

Supported in
  • Accelo
  • ActiveCampaign
  • Affinity
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
created_at
string · date-time

The date and time of the account's creation

Supported in
  • Accelo
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Salesforce
  • Zoho CRM
updated_at
string · date-time

The date and time of the account's last update

Supported in
  • Accelo
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Salesforce
  • Teamleader
  • Zoho CRM
city
string

The city of the contacts

Supported in
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
state
string

The state of the contacts

Supported in
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
country
string

The country of the accounts

Supported in
  • Close
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
owner
object

The account's owner

Integration specific notes
  • CopperThe owner of the accounts
  • HubSpotThe owner of the accounts
  • PipedriveThe owner of the accounts. This filter is mutually exclusive to other filters. If this filter is used, the other filters should not be set.
Supported in
  • Copper
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string

The owner's unique identifier

industry
string

The industry of the accounts.

Supported in
  • HubSpot
  • Salesforce
  • Zoho CRM
number_of_employees
string

The number of employess of the accounts.

Supported in
  • HubSpot
  • Salesforce
  • Zoho CRM
website
string

The website of the account.

Supported in
  • HubSpot
  • Salesforce
fields
array

The list of custom field names in include.

Supported in
  • HubSpot
last_activity_at
string · date-time

The date and time of the account's last activity

Supported in
  • Salesforce
  • Zoho CRM
include_custom_fields
array

Include Custom fields to retrive from the account.

Supported in
  • Salesforce
custom_fields
Supported in
  • Salesforce
view_id
string

The view id of the accounts

Supported in
  • FreshSales
email_addresses
Supported in
  • Teamleader
  • Zendesk Sell
tags
array

The contact's tags

Supported in
  • Teamleader
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
  • description
  • email_addresses
  • name
  • updated_at
Enum support by integration
  • Teamleader
    • name
    • created_at
    • updated_at
  • Zendesk Sell
    • email_addresses
    • created_at
    • updated_at
    • name
  • Planhat
    • name
    • description
    • created_at
    • updated_at
Supported in
  • Planhat
  • Teamleader
  • Zendesk Sell
phone_numbers
array
Supported in
  • Zendesk Sell
addresses
array
Supported in
  • Zendesk Sell

Response Body ​

result
object[]

List of Accounts

id
string
REQUIRED · 

The account's unique identifier

Supported in
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
owner
object

The account's owner

Supported in
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The owner's unique identifier

name
string

The account's name

Supported in
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
description
string

The account's description

Supported in
  • Accelo
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
industry
string

The account's industry

Supported in
  • Close
  • HubSpot
  • Outreach
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
website
string

The account's website

Supported in
  • Accelo
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
number_of_employees
integer

The account's number of employees

Supported in
  • Close
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
addresses
object[]
Supported in
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The unique identifier of the address

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

phone_numbers
object[]
Supported in
  • Accelo
  • Capsule
  • Copper
  • HubSpot
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The unique identifier of the phone number

number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

urls
object[]

The candidate's urls

Supported in
  • Affinity
  • Copper
  • Planhat
  • Teamleader
url
string

The candidate's URL

type
string

The candidate's URL type

tags
object[]

The contact's tags

Supported in
  • Copper
  • Outreach
  • Planhat
  • Teamleader
  • Zendesk Sell
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 account's last activity

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

The date and time of the account's last update

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
created_at
string · date-time

The date and time of the account's creation

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • 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.