List emails in the inbox

GET

/api/v1/email/inbox

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

Paginated; filter by read, starred, archived (default false), label, lead_id, dates, direction and search. AI-team email is excluded unless include_ai=true. Scope follows the caller’s email view permission.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

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

is_archived

string

default: false

Allowed values: true false

label

string

<= 50 characters

lead_id

string

from_date

string format: date-time

to_date

string format: date-time

search

string

<= 200 characters

direction

string

Allowed values: inbound outbound

sort

string

default: newest

Allowed values: newest oldest

include_ai

string

Allowed values: true false

Responses

200

A page of emails

Media typeapplication/json

object

items

required

Array<object>

object

_id

required

string

subject

required

string

body_preview

required

string

from

to

direction

required

string

Allowed values: inbound outbound

is_read

required

boolean

is_starred

required

boolean

is_archived

required

boolean

labels

required

Array<string>

lead_id

required

string | null

lead_name

required

string | null

thread_id

required

string | null

key

additional properties

any

total

required

number

page

required

number

limit

required

number

has_next

required

boolean

Example

{
  "items": [
    {
      "direction": "inbound"
    }
  ]
}

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