Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List contracts

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

Paginated; filter by lead_id, status (draft, sent, viewed, signed, expired, cancelled) and created_by. Each row carries created_by_user. Limited to the contracts the caller may view (own, team or all).

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 viewed signed counter_signed expired cancelled
created_by

Only documents created by these users: one user id or a comma-separated list (max 50). Never widens the caller’s own/team scope.

string
<= 1300 characters

Only documents created by these users: one user id or a comma-separated list (max 50). Never widens the caller’s own/team scope.

A page of contracts

Media typeapplication/json
object
contracts
required
Array<object>
object
_id
required
string
name
required
string
status
required
string
lead_id
required
string
proposal_id
required
string | null
public_token
required
string
created_by
required
string
created_by_user
required
Any of:
object
id
required
string
name
required
string
avatar_url
required
string | null
key
additional properties
any
total
required
number
page
required
number
limit
required
number
totalPages
required
number
Examplegenerated
{
"contracts": [
{
"_id": "example",
"name": "example",
"status": "example",
"lead_id": "example",
"proposal_id": "example",
"public_token": "example",
"created_by": "example",
"created_by_user": {
"id": "example",
"name": "example",
"avatar_url": "example"
}
}
],
"total": 1,
"page": 1,
"limit": 1,
"totalPages": 1
}

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

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

Role permission or token scope missing; OAuth app tokens are not accepted on this route

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

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