Appearance

List Opportunities ​

Endpoint ​

http
GET /unified/crm/opportunities
Integrations supported
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • 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

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
owner
object

The opportunity's owner

Supported in
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The opportunity's owner's unique identifier

account
object

Only either account or contact should be set.

Supported in
  • ActiveCampaign
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The account's unique identifier

status
string

The opportunity's status

All possible enum values:
  • abandoned
  • all
  • closed
  • deleted
  • lost
  • open
  • won
Enum support by integration
  • Pipedrive
    • open
    • won
    • lost
    • deleted
  • Salesforce
    • open
    • closed
    • won
  • Pipeliner
    • open
    • lost
    • won
  • Highlevel
    • open
    • won
    • lost
    • abandoned
    • all
Supported in
  • Accelo
  • ActiveCampaign
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Teamleader
created_at
string · date-time

The date and time of the opportunity's creation

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Outreach
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zoho CRM
updated_at
string · date-time

The date and time of the opportunity's last update

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Outreach
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zoho CRM
close_date
string · date-time

The date and time of the opportunity's close date

Supported in
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zoho CRM
amount
number

The opportunity's amount

Supported in
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
search_term

Searches by name, contact and account.

Supported in
  • ActiveCampaign
  • Capsule
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesflare
  • Salesforce
name
string

The opportunity's name

Supported in
  • ActiveCampaign
  • Capsule
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
contact
array

Only either contact or account should be set.

Supported in
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Teamleader
  • Zendesk Sell
stage
object

The opportunity's stage

Supported in
  • ActiveCampaign
  • Capsule
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The stage's unique identifier

name
string

The stage's name

fields
Supported in
  • HubSpot
  • Salesforce
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:
  • account
  • amount
  • close-date
  • close_date
  • contact
  • created_at
  • created_by
  • last_activity_at
  • name
  • status
  • updated_at
Enum support by integration
  • Outreach
    • name
    • amount
    • close_date
    • created_at
    • updated_at
  • Pipedrive
    • created_at
    • updated_at
  • Freshsales
    • name
    • created_at
    • updated_at
    • last_activity_at
  • ActiveCampaign
    • name
    • created_at
    • amount
    • contact
    • account
  • Teamleader
    • created_by
    • amount
  • Zendesk Sell
    • name
    • amount
    • created_at
    • updated_at
  • Planhat
    • name
    • status
    • close_date
  • Pipeliner
    • name
    • created_at
    • updated_at
    • close-date
  • Salesflare
    • name
    • close_date
    • updated_at
    • created_at
    • last_activity_at
  • Highlevel
    • created_at
    • updated_at
Supported in
  • ActiveCampaign
  • Freshsales
  • Highlevel
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Teamleader
  • Zendesk Sell
last_activity_at
string · date-time

The date and time of the opportunity's last activity

Supported in
  • Salesforce
  • Zoho CRM
custom_fields
object

All the custom fields present on the opportunity

Supported in
  • Salesforce
tags
array

The opportunity's tags

Supported in
  • Capsule
  • Copper
  • Salesflare
name
currency
string

The amount attribute's currency

Supported in
  • Capsule
view_id
string

The view id of the opportunities

Supported in
  • Freshsales
description
string

The opportunity's description

Supported in
  • Microsoft Dynamics 365 Sales
  • Pipeliner

Response Body ​

result
object[]

List of Opportunities

id
string
REQUIRED · 

The opportunity's unique identifier

Supported in
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
name
string

The opportunity's name

Supported in
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
description
string

The opportunity's description

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zoho CRM
amount
number

The opportunity's amount

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
currency
string

The amount attribute's currency

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Freshsales
  • Insightly
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Teamleader
  • Zendesk Sell
owner
object

The opportunity's owner

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The opportunity's owner's unique identifier

account
object

The opportunity's account

Supported in
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The account's unique identifier

contact
object[]

The opportunity's contacts

Supported in
  • Accelo
  • ActiveCampaign
  • Affinity
  • Capsule
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Teamleader
  • Zendesk Sell
id
string

The contact's unique identifier

stage
object

The opportunity's stage

Supported in
  • ActiveCampaign
  • Capsule
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The stage's unique identifier

name
string

The stage's name

status
string

The opportunity's status

Supported in
  • Accelo
  • ActiveCampaign
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • Insightly
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Teamleader
tags
object[]

The opportunity's tags

Supported in
  • Capsule
  • Copper
  • Freshsales
  • Highlevel
  • Insightly
  • Salesflare
  • Zendesk Sell
id
string

The tag's unique identifier

name
string

The tag's name

custom_fields
object

All the custom fields present on the opportunity

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
last_activity_at
string · date-time

The date and time of the opportunity's last activity

Supported in
  • Accelo
  • Capsule
  • Close
  • Copper
  • Freshsales
  • Highlevel
  • Insightly
  • Outreach
  • Pipedrive
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
close_date
string · date-time

The date and time of the opportunity's close date

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zoho CRM
created_at
string · date-time

The date and time of the opportunity's creation

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
updated_at
string · date-time

The date and time of the opportunity's last update

Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
urls
object[]

The opportunity's urls

Supported in
  • Highlevel
  • Pipedrive
url
string

The opportunity's URL

type
string

The opportunity's URL type

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.