Skip to main content
GET
Get outreach home

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Query Parameters

tab
string | null
outcome
string | null
search
string | null
Maximum string length: 120
website_id
integer
required

Target website id

Response

Successful Response

tabs
OutreachHomeTabs · object
required
outcomes
OutreachHomeOutcomes · object
required
actions
OutreachHomeActions · object
required
results
OutreachHomeResults · object
required
agent_now
OutreachAgentLine · object
required
agent_next
OutreachAgentLine · object
required
contact_allowance
OutreachContactAllowance · object
required
mailbox
OutreachHomeMailbox · object
required
send_disabled
boolean
default:false
decisions_waiting
Decisions Waiting · object | null
rows
OutreachSourceListItem · object[]
total
integer
default:0
agent_mode
boolean
default:false
told_after
OutreachToldAfter · object | null