Public API - Opportunities
Top sales-outreach opportunities
Highest-intent companies with a recommended person to contact, ranked by score. Optionally filter by time window, ICP ids, and account-list ids.
POST
/
public
/
v1
/
opportunities
/
top
Top sales-outreach opportunities
curl --request POST \
--url https://app.stairoids.com/api/public/v1/opportunities/top \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"afterTime": 0,
"beforeTime": 0,
"icpIds": [
123
],
"accountListIds": [
123
],
"page": 0,
"size": 20
}
'import requests
url = "https://app.stairoids.com/api/public/v1/opportunities/top"
payload = {
"afterTime": 0,
"beforeTime": 0,
"icpIds": [123],
"accountListIds": [123],
"page": 0,
"size": 20
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
afterTime: 0,
beforeTime: 0,
icpIds: [123],
accountListIds: [123],
page: 0,
size: 20
})
};
fetch('https://app.stairoids.com/api/public/v1/opportunities/top', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stairoids.com/api/public/v1/opportunities/top",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'afterTime' => 0,
'beforeTime' => 0,
'icpIds' => [
123
],
'accountListIds' => [
123
],
'page' => 0,
'size' => 20
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stairoids.com/api/public/v1/opportunities/top"
payload := strings.NewReader("{\n \"afterTime\": 0,\n \"beforeTime\": 0,\n \"icpIds\": [\n 123\n ],\n \"accountListIds\": [\n 123\n ],\n \"page\": 0,\n \"size\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.stairoids.com/api/public/v1/opportunities/top")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"afterTime\": 0,\n \"beforeTime\": 0,\n \"icpIds\": [\n 123\n ],\n \"accountListIds\": [\n 123\n ],\n \"page\": 0,\n \"size\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.stairoids.com/api/public/v1/opportunities/top")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"afterTime\": 0,\n \"beforeTime\": 0,\n \"icpIds\": [\n 123\n ],\n \"accountListIds\": [\n 123\n ],\n \"page\": 0,\n \"size\": 20\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"company": {
"companyId": 4521,
"name": "Acme Corp",
"domain": "acme.com",
"industry": "Software",
"country": "Netherlands",
"city": "Amsterdam",
"employeeCount": 250,
"companySize": "201-500",
"linkedInUrl": "https://www.linkedin.com/company/acme",
"totalScore": 87,
"icpMatched": true,
"icpId": 7,
"icpName": "Mid-market SaaS",
"rankedLeadScoreId": 55231,
"logoUrl": "<string>",
"funnelStageId": 12,
"funnelStage": "Hot",
"labels": [
{
"id": 5,
"name": "Strategic",
"color": "#73d89c",
"userGenerated": true,
"tag": true
}
],
"latestActivityTimestamp": 1719500000000
},
"person": {
"publicIdentifier": "jane-doe-123",
"name": "Jane Doe",
"headline": "VP of Marketing",
"linkedInUrl": "<string>",
"profilePicture": "<string>"
},
"personScore": 42,
"funnelStageId": 12
}
],
"page": 0,
"size": 20,
"totalElements": 137,
"totalPages": 7
}{
"errorType": "EMAIL_ALREADY_EXISTS"
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123,
"addOnSlug": "<string>",
"planSlug": "<string>",
"addOnPriceMonthly": 123,
"upgradePlanSlug": "<string>",
"upgradePlanName": "<string>",
"upgradePlanPriceMonthly": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS"
}Authorizations
Your organization's public API key.
Body
application/json
Request for the top sales-outreach opportunities.
Only count activity at/after this epoch-millis timestamp. 0 or null = all time.
Example:
0
Only count activity before this epoch-millis timestamp. 0 or null = no upper bound.
Example:
0
Restrict to these ICP ids. Null or empty = all ICPs.
Restrict to these ICP ids. Null or empty = all ICPs.
Restrict to these account-list ids. Null or empty = all lists.
Restrict to these account-list ids. Null or empty = all lists.
Zero-based page index.
Example:
0
Page size (clamped to 100).
Example:
20
Response
OK
A page of results.
⌘I
Top sales-outreach opportunities
curl --request POST \
--url https://app.stairoids.com/api/public/v1/opportunities/top \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"afterTime": 0,
"beforeTime": 0,
"icpIds": [
123
],
"accountListIds": [
123
],
"page": 0,
"size": 20
}
'import requests
url = "https://app.stairoids.com/api/public/v1/opportunities/top"
payload = {
"afterTime": 0,
"beforeTime": 0,
"icpIds": [123],
"accountListIds": [123],
"page": 0,
"size": 20
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
afterTime: 0,
beforeTime: 0,
icpIds: [123],
accountListIds: [123],
page: 0,
size: 20
})
};
fetch('https://app.stairoids.com/api/public/v1/opportunities/top', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stairoids.com/api/public/v1/opportunities/top",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'afterTime' => 0,
'beforeTime' => 0,
'icpIds' => [
123
],
'accountListIds' => [
123
],
'page' => 0,
'size' => 20
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stairoids.com/api/public/v1/opportunities/top"
payload := strings.NewReader("{\n \"afterTime\": 0,\n \"beforeTime\": 0,\n \"icpIds\": [\n 123\n ],\n \"accountListIds\": [\n 123\n ],\n \"page\": 0,\n \"size\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.stairoids.com/api/public/v1/opportunities/top")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"afterTime\": 0,\n \"beforeTime\": 0,\n \"icpIds\": [\n 123\n ],\n \"accountListIds\": [\n 123\n ],\n \"page\": 0,\n \"size\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.stairoids.com/api/public/v1/opportunities/top")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"afterTime\": 0,\n \"beforeTime\": 0,\n \"icpIds\": [\n 123\n ],\n \"accountListIds\": [\n 123\n ],\n \"page\": 0,\n \"size\": 20\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"company": {
"companyId": 4521,
"name": "Acme Corp",
"domain": "acme.com",
"industry": "Software",
"country": "Netherlands",
"city": "Amsterdam",
"employeeCount": 250,
"companySize": "201-500",
"linkedInUrl": "https://www.linkedin.com/company/acme",
"totalScore": 87,
"icpMatched": true,
"icpId": 7,
"icpName": "Mid-market SaaS",
"rankedLeadScoreId": 55231,
"logoUrl": "<string>",
"funnelStageId": 12,
"funnelStage": "Hot",
"labels": [
{
"id": 5,
"name": "Strategic",
"color": "#73d89c",
"userGenerated": true,
"tag": true
}
],
"latestActivityTimestamp": 1719500000000
},
"person": {
"publicIdentifier": "jane-doe-123",
"name": "Jane Doe",
"headline": "VP of Marketing",
"linkedInUrl": "<string>",
"profilePicture": "<string>"
},
"personScore": 42,
"funnelStageId": 12
}
],
"page": 0,
"size": 20,
"totalElements": 137,
"totalPages": 7
}{
"errorType": "EMAIL_ALREADY_EXISTS"
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123,
"addOnSlug": "<string>",
"planSlug": "<string>",
"addOnPriceMonthly": 123,
"upgradePlanSlug": "<string>",
"upgradePlanName": "<string>",
"upgradePlanPriceMonthly": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS"
}