List opportunities

GET

/api/v1/opportunities

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/opportunities?page=1&limit=25&status_type=active&stalled=1' \
  --header 'Authorization: Bearer <token>'

Paginated. Limited to opportunities on leads the caller may view; each carries is_at_risk and owner_name.

Authorizations

• bearerJwt
• personalAccessToken
  read:opportunities
• oauthAccessToken

Parameters

Query Parameters

page

number

default: 1 >= 1

limit

number

default: 25 >= 1 <= 100

pipeline_id

string

/^[0-9a-fA-F]{24}$/

status_type

string

Allowed values: active won lost

lead_id

string

/^[0-9a-fA-F]{24}$/

owner_id

string

/^[0-9a-fA-F]{24}(,[0-9a-fA-F]{24})*$/

close_date_from

string format: date-time

close_date_to

string format: date-time

stalled

string

Allowed values: 1 true

Responses

200

A page of opportunities

Media typeapplication/json

object

opportunities

required

Array<object>

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

total

required

number

page

required

number

limit

required

number

totalPages

required

number

Example^generated

{
  "opportunities": [
    {
      "_id": "example",
      "lead_id": "example",
      "value": 1,
      "is_at_risk": true,
      "owner_name": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "totalPages": 1
}

400

Validation failed

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"
    }
  ]
}

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"
    }
  ]
}