Skip to main content
GET
List outreach sources

Authorizations

Authorization
string
header
required

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

Query Parameters

tab
enum<string> | null

Tab to list: active, needs_you, hikoo_working, waiting, in_progress or closed.

Available options:
active,
needs_you,
hikoo_working,
waiting,
closed,
in_progress
outcome
enum<string> | null

Narrows the closed tab: won, lost, disqualified.

Available options:
won,
lost,
disqualified
status
string | null

Comma-separated statuses

search
string | null
Maximum string length: 120
sort
enum<string>
default:stage
Available options:
priority,
domain,
status,
stage,
contact,
owner,
citations,
updated
direction
enum<string>
default:desc
Available options:
asc,
desc
limit
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0
website_id
integer
required

Target website id

Response

Successful Response

sources
OutreachSourceListItem · object[]
required
total
integer
required