Skip to main content
GET
/
v1
/
integrations
/
opportunities
Get opportunities
curl --request GET \
  --url https://api.example.com/v1/integrations/opportunities \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "externalId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "amount": 123,
    "closedAt": "<string>",
    "disposition": "<string>",
    "recordingId": "<string>",
    "accountId": "<string>",
    "account": "<unknown>",
    "opportunityUsers": [
      "<unknown>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string
​
recordingId
string
​
externalId
string

Response

200 - application/json

Get opportunities

​
id
string
required
​
externalId
string
required

The ID of the opportunity in the external system (e.g. Salesforce)

​
createdAt
string
required

The date the opportunity was created

​
updatedAt
string
required

The date the opportunity was last updated

​
organizationId
string
required
​
name
string | null

The name of the opportunity

​
amount
number

The dollar amount of the opportunity

​
closedAt
string

The closure date of the opportunity

​
disposition
string

"WON" | "LOST" | "OPEN"

​
recordingId
string

The ID of the recording associated to the opportunity

​
accountId
string
​
account
unknown
​
opportunityUsers
null[]