Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.
List the unified inbox
GET
/api/v1/inbox
const url = 'https://api.pitch2sale.com/api/v1/inbox?view=do&tab=primary&page=1&limit=50&sort=due_date&include_ai=true';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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>'One page of the chosen tab (view do / done / future) plus the badge count of every tab. counts.follow_ups is the caller’s open Follow-ups cards (0 unless Follow-ups is on for the organization); counts.all is an alias of counts.primary.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”view
string
tab
string
page
integer
limit
integer
sort
string
include_ai
string
filters
object
assignee
Any of:
string
Array<string>
lead_status
Any of:
string
Array<string>
priority
Any of:
string
Array<string>
has_overdue
boolean
date_from
string format: date-time
date_to
string format: date-time
Responses
Section titled “Responses”A page of inbox items and the tab counts
Media typeapplication/json
object
items
required
Array<object>
object
key
additional properties
counts
required
object
primary
required
number
emails
required
number
calls
required
number
messages
required
number
tasks
required
number
reminders
required
number
potential_contacts
required
number
awaiting_reply
required
number
follow_ups
required
number
all
required
number
pagination
required
object
page
required
number
limit
required
number
total
required
number
Examplegenerated
{ "items": [ { "additionalProperty": "example" } ], "counts": { "primary": 1, "emails": 1, "calls": 1, "messages": 1, "tasks": 1, "reminders": 1, "potential_contacts": 1, "awaiting_reply": 1, "follow_ups": 1, "all": 1 }, "pagination": { "page": 1, "limit": 1, "total": 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; 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" } ]}