Skip to main content
GET
/
api
/
v1
/
opportunities
/
{opportunity}
Get an opportunity
curl --request GET \
  --url https://supmaya.com/api/v1/opportunities/{opportunity} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "status": "<string>",
  "summary": "<string>",
  "value": 123,
  "contact_id": 123,
  "agent_id": 123,
  "follow_up_requested": true,
  "follow_up_type": "<string>",
  "webhook_sent": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
opportunity
integer<int64>
required

Response

Opportunity

​
id
integer<int64>
​
name
string
​
status
string | null
​
summary
string | null
​
value
number<float> | null
​
contact_id
integer<int64> | null
​
agent_id
integer<int64> | null
​
follow_up_requested
boolean
​
follow_up_type
string | null
​
webhook_sent
boolean
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null