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 email threads

GET
/api/v1/email/threads
curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/email/threads?page=1&limit=20&is_read=true&is_starred=true&sort=newest&include_ai=true' \
  --header 'Authorization: Bearer <token>'

Paginated conversation view of the inbox, newest activity first.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1
limit
integer
default: 20 >= 1 <= 100
is_read
string
Allowed values: true false
is_starred
string
Allowed values: true false
search
string
<= 200 characters
lead_id
string
sort
string
default: newest
Allowed values: newest oldest
include_ai
string
Allowed values: true false

Responses

Section titled “Responses”

200

Section titled “200”

A page of threads

Media typeapplication/json
object
items
required
Array<object>
object
thread_id
required
string
subject
required
string
preview
required
string
email_count
required
number
unread_count
required
number
latest_activity_at
required
string
lead_id
required
string | null
lead_name
required
string | null
is_starred
required
boolean
has_attachments
required
boolean
key
additional properties
any
total
required
number
page
required
number
limit
required
number
has_next
required
boolean
Examplegenerated
{
  "items": [
    {
      "thread_id": "example",
      "subject": "example",
      "preview": "example",
      "email_count": 1,
      "unread_count": 1,
      "latest_activity_at": "example",
      "lead_id": "example",
      "lead_name": "example",
      "is_starred": true,
      "has_attachments": true
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "has_next": true
}

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

402

Section titled “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
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"
    }
  ]
}