List inbox

GET

/api/v1/inbox

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/inbox?view=do&tab=primary&page=1&limit=50&sort=due_date&include_ai=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Query Parameters

view

string

default: do

Allowed values: do done future

tab

string

default: primary

Allowed values: primary emails calls messages tasks reminders potential_contacts awaiting_reply all

page

integer

default: 1 >= 1

limit

integer

default: 50 >= 1 <= 100

sort

string

default: due_date

Allowed values: due_date recent oldest

include_ai

string

Allowed values: true false

filters

object

assignee

Any of:

string

string

Array<string>

Array<string>

lead_status

Any of:

string

string

Array<string>

Array<string>

priority

Any of:

string

string

Array<string>

Array<string>

has_overdue

boolean

date_from

string format: date-time

date_to

string format: date-time

Responses

200

OK

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