Opportunity
object is used to represent a deal opportunity in a CRM system.name
Stringdescription
Stringamount
Integerowner
Stringaccount
Stringstage
Stringstatus
EnumOPEN
, WON
, LOST
, or -
in cases where there is no clear mapping - the original value passed through.last_activity_at
Stringclose_date
Stringremote_created_at
Stringremote_was_deleted
Booleanid
Stringremote_id
Stringfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]remote_fields
RemoteField[]{"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938",Show advanced fields}
Returns a list of Opportunity
objects.
Authorization
StringX-Account-Token
Stringaccount_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleanmodified_after
Stringmodified_before
Stringowner_id
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
Stringstage_id
Stringstatus
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938",Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
StringCreates an Opportunity
object with the given values.
Authorization
StringX-Account-Token
Stringis_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringdescription
Stringamount
Integerowner
Stringid
field in the User object.account
Stringid
field in the Account object.stage
Stringid
field in the Stage object.status
EnumOPEN
, WON
, LOST
.last_activity_at
Stringclose_date
Stringintegration_params
Objectlinked_account_params
Objectremote_fields
Array{"model": {"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z"}}
{"model": {"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938",Show advanced fields}}

Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
amount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
StringReturns an Opportunity
object with the given id
.
Authorization
StringX-Account-Token
Stringexpand
Stringid
Stringinclude_remote_data
Booleaninclude_remote_fields
Booleanremote_fields
Stringshow_enum_origins
String{"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938",Show advanced fields}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
account
Stringamount
Integerclose_date
Stringdescription
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstage
StringUpdates an Opportunity
object with the given id
.
Authorization
StringX-Account-Token
Stringid
Stringis_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringdescription
Stringamount
Integerowner
Stringid
field in the Owner object.account
Stringid
field in the Account object.stage
Stringid
field in the Stage object.status
EnumOPEN
, WON
, LOST
.last_activity_at
Stringclose_date
Stringintegration_params
Objectlinked_account_params
Objectremote_fields
Array{"model": {"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z"}}
{"model": {"name": "Needs Integrations","description": "Needs a Unified API for Integrations!","amount": 100000,"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa","account": "0958cbc6-6040-430a-848e-aafacbadf4ae","stage": "1968cbc6-6040-430a-848e-aafacbadf4ad","status": "WON","last_activity_at": "2022-02-10T00:00:00Z","close_date": "2022-02-10T00:00:00Z","remote_created_at": "2021-11-10T00:00:00Z","remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938",Show advanced fields}}

Merge supports Passthrough Requests to this platform's API
Supported PATCH Model Parameters
amount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_created_at
Stringstage
String
Merge supports Passthrough Requests to this platform's API
Supported PATCH Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
Stringname
Stringowner
Stringremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported PATCH Model Parameters
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported PATCH Model Parameters
account
Stringamount
Integerclose_date
Stringlast_activity_at
Stringname
Stringowner
Stringremote_created_at
Stringremote_id
Stringstage
Stringstatus
Enum
Merge supports Passthrough Requests to this platform's API
Supported PATCH Model Parameters
account
Stringamount
Integerclose_date
Stringdescription
String