Skip to main content
GET
Get outreach data

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Query Parameters

brand
string
required

The brand ID (32-character hexadecimal string)

Required string length: 32
Pattern: ^[0-9a-fx]{32}$
opportunity_type
enum<string>

Filter by opportunity type

Available options:
low-hanging-fruit,
publication-gap
status
enum<string>

Filter by opportunity status

Available options:
New,
In Progress,
Done,
Archived
difficulty
enum<string>

Filter by difficulty level

Available options:
Easy,
Medium,
Hard
domain
string

Filter by domain (substring match)

archived
boolean

Include archived opportunities (default: false)

sort_by
enum<string>
default:priority_score

Sort opportunities by field

Available options:
priority_score,
fit_score,
last_seen
limit
integer
default:100

Number of items per page (1-500)

Required range: 1 <= x <= 500
cursor
string

Pagination cursor from previous response

Response

Successful response

brand_id
string
required

The brand ID

Example:

"1749113348709x432280934699237400"

opportunities
object[]
required

Array of outreach opportunity objects

pagination
object
required