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 tasks

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

Paginated. Limited to tasks the caller may view (assigned to them, their team, or all, by role).

page
number
default: 1 >= 1
limit
number
default: 25 >= 1 <= 200
assigned_to
string
/^[0-9a-fA-F]{24}$/
lead_id
string
/^[0-9a-fA-F]{24}$/
project_id
string
/^[0-9a-fA-F]{24}$/
is_complete
boolean

A page of tasks

Media typeapplication/json
object
tasks
required
Array<object>
object
_id
required
string
title
required
string
key
additional properties
any
total
required
number
page
required
number
limit
required
number
Examplegenerated
{
"tasks": [
{
"_id": "example",
"title": "example"
}
],
"total": 1,
"page": 1,
"limit": 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"
}
]
}

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

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

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