Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List proposals

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

Paginated; filter by lead_id and status (draft, sent, accepted, declined). Limited to the proposals the caller may view (own, team or all).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
number
default: 1 >= 1
limit
number
default: 25 >= 1 <= 100
lead_id
string
/^[0-9a-fA-F]{24}$/
status
string
Allowed values: draft sent accepted declined

Responses

Section titled “Responses”

200

Section titled “200”

A page of proposals

Media typeapplication/json
object
proposals
required
Array<object>
object
_id
required
string
name
required
string
status
required
string
lead_id
required
string
currency
required
string
public_token
required
string | null
key
additional properties
any
total
required
number
page
required
number
limit
required
number
totalPages
required
number
Examplegenerated
{
  "proposals": [
    {
      "_id": "example",
      "name": "example",
      "status": "example",
      "lead_id": "example",
      "currency": "example",
      "public_token": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "totalPages": 1
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}