Skip to content

List Opportunities

Endpoint

http
GET /unified/crm/opportunities
Integrations supported
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • 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 opportunity's owner
Supported in
  • ActiveCampaign
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
id
string
The opportunity's owner's unique identifier
account
object
The opportunity's account
Supported in
  • ActiveCampaign
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Salesforce
id
string
The account's unique identifier
status
string
The opportunity's status
All possible enum values:
  • closed
  • open
  • won
Supported in
  • Accelo
  • ActiveCampaign
  • Close
  • Copper
  • Pipedrive
  • Salesforce
created_at
string · date-time
The date and time of the opportunity's creation
Supported in
  • Accelo
  • ActiveCampaign
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Salesforce
updated_at
string · date-time
The date and time of the opportunity's last update
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Salesforce
name
string
The opportunity's name
Supported in
  • ActiveCampaign
  • Copper
  • HubSpot
  • Outreach
  • Salesforce
amount
number
The opportunity's amount
Supported in
  • HubSpot
contact
array
The opportunity's contacts
Supported in
  • HubSpot
  • Outreach
  • Salesforce
stage
object
The opportunity's stage
Supported in
  • ActiveCampaign
  • Copper
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
id
string
The stage's unique identifier
name
string
The stage's name
close_date
string · date-time
The date and time of the opportunity's close date
Supported in
  • Copper
  • HubSpot
  • Salesforce
include_custom_fields
Supported in
  • Salesforce
custom_fields
Supported in
  • Salesforce
tags
array
The opportunity's tags
Supported in
  • Copper
view_id
string
The view id of the opportunities
Supported in
  • FreshSales
search_term
Searches by name, contact and 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:
  • account
  • amount
  • contact
  • created_at
  • name
Supported in
  • ActiveCampaign

Response Body

result
object[]
List of Opportunities
id
string
REQUIRED · The note's unique identifier
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
name
string
The opportunity's name
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
description
string
The opportunity's description
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Salesforce
  • Zoho CRM
amount
number
The opportunity's amount
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
currency
string
The amount attribute's currency
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
owner
object
The opportunity's owner
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string
The opportunity's owner's unique identifier
account
object
The opportunity's account
Supported in
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
id
string
The account's unique identifier
contact
object[]
The opportunity's contacts
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • HubSpot
  • Outreach
  • Salesforce
id
string
The contact's unique identifier
stage
object
The opportunity's stage
Supported in
  • ActiveCampaign
  • Capsule
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • 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
  • FreshSales
  • Pipedrive
  • Salesforce
tags
object[]
The opportunity's tags
Supported in
  • Capsule
  • Copper
  • FreshSales
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 opportunity's last activity
Supported in
  • Accelo
  • Close
  • Copper
  • FreshSales
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
close_date
string · date-time
The date and time of the opportunity's close date
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
created_at
string · date-time
The date and time of the opportunity's creation
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Outreach
  • Pipedrive
  • Salesforce
  • Zoho CRM
updated_at
string · date-time
The date and time of the opportunity's last update
Supported in
  • Accelo
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • FreshSales
  • 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.