Retrieve an opportunity

GET

/api/v1/opportunities/{id}

curl --request GET \
  --url https://api.pitch2sale.com/api/v1/opportunities/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerJwt
• personalAccessToken
  read:opportunities
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Responses

200

The opportunity

Media typeapplication/json

object

opportunity

required

object

_id

required

string

lead_id

required

string

value

required

number

is_at_risk

required

boolean

owner_name

required

string | null

key

additional properties

any

Example^generated

{
  "opportunity": {
    "_id": "example",
    "lead_id": "example",
    "value": 1,
    "is_at_risk": true,
    "owner_name": "example"
  }
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}