Rank companies by intent score
Companies ranked by score. Provide a startDate/endDate window to re-score by recent activity only; omit both to rank by the stored all-time score. Optional stage / ICP / label / persona / list filters.
curl --request POST \
--url https://app.stairoids.com/api/public/v1/companies/ranked \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"stageIds": [
123
],
"icpIds": [
123
],
"labelIds": [
123
],
"unLabeledOnly": false,
"unTaggedOnly": false,
"employeePersonaIds": [
123
],
"startDate": 1717200000000,
"endDate": 1719792000000,
"listId": 123,
"page": 0,
"size": 50
}
'import requests
url = "https://app.stairoids.com/api/public/v1/companies/ranked"
payload = {
"stageIds": [123],
"icpIds": [123],
"labelIds": [123],
"unLabeledOnly": False,
"unTaggedOnly": False,
"employeePersonaIds": [123],
"startDate": 1717200000000,
"endDate": 1719792000000,
"listId": 123,
"page": 0,
"size": 50
}
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({
stageIds: [123],
icpIds: [123],
labelIds: [123],
unLabeledOnly: false,
unTaggedOnly: false,
employeePersonaIds: [123],
startDate: 1717200000000,
endDate: 1719792000000,
listId: 123,
page: 0,
size: 50
})
};
fetch('https://app.stairoids.com/api/public/v1/companies/ranked', 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/companies/ranked",
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([
'stageIds' => [
123
],
'icpIds' => [
123
],
'labelIds' => [
123
],
'unLabeledOnly' => false,
'unTaggedOnly' => false,
'employeePersonaIds' => [
123
],
'startDate' => 1717200000000,
'endDate' => 1719792000000,
'listId' => 123,
'page' => 0,
'size' => 50
]),
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/companies/ranked"
payload := strings.NewReader("{\n \"stageIds\": [\n 123\n ],\n \"icpIds\": [\n 123\n ],\n \"labelIds\": [\n 123\n ],\n \"unLabeledOnly\": false,\n \"unTaggedOnly\": false,\n \"employeePersonaIds\": [\n 123\n ],\n \"startDate\": 1717200000000,\n \"endDate\": 1719792000000,\n \"listId\": 123,\n \"page\": 0,\n \"size\": 50\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/companies/ranked")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"stageIds\": [\n 123\n ],\n \"icpIds\": [\n 123\n ],\n \"labelIds\": [\n 123\n ],\n \"unLabeledOnly\": false,\n \"unTaggedOnly\": false,\n \"employeePersonaIds\": [\n 123\n ],\n \"startDate\": 1717200000000,\n \"endDate\": 1719792000000,\n \"listId\": 123,\n \"page\": 0,\n \"size\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.stairoids.com/api/public/v1/companies/ranked")
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 \"stageIds\": [\n 123\n ],\n \"icpIds\": [\n 123\n ],\n \"labelIds\": [\n 123\n ],\n \"unLabeledOnly\": false,\n \"unTaggedOnly\": false,\n \"employeePersonaIds\": [\n 123\n ],\n \"startDate\": 1717200000000,\n \"endDate\": 1719792000000,\n \"listId\": 123,\n \"page\": 0,\n \"size\": 50\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
},
"windowedScore": 640
}
],
"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
Filter + time window for the cool-score (time-windowed) ranking.
Funnel stage ids to include. Empty = all stages.
Funnel stage ids to include. Empty = all stages.
ICP ids to include. Empty = all ICPs.
ICP ids to include. Empty = all ICPs.
Label ids to include. Empty = all labels.
Label ids to include. Empty = all labels.
Return only companies with no Label attached (entries with tag=false); Tags don't count. OR-combines with labelIds.
false
Return only companies with no Tag attached (entries with tag=true); Labels don't count. OR-combines with labelIds.
false
Employee-persona ids to restrict to. Empty = no persona filter.
Employee-persona ids to restrict to. Empty = no persona filter.
Window start, epoch millis. Omit both startDate and endDate to rank by stored all-time score.
1717200000000
Window end, epoch millis.
1719792000000
Restrict to a single account-list id. Null = all lists.
Zero-based page index.
0
Page size (clamped to 100).
50
Response
OK
A page of results.
curl --request POST \
--url https://app.stairoids.com/api/public/v1/companies/ranked \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"stageIds": [
123
],
"icpIds": [
123
],
"labelIds": [
123
],
"unLabeledOnly": false,
"unTaggedOnly": false,
"employeePersonaIds": [
123
],
"startDate": 1717200000000,
"endDate": 1719792000000,
"listId": 123,
"page": 0,
"size": 50
}
'import requests
url = "https://app.stairoids.com/api/public/v1/companies/ranked"
payload = {
"stageIds": [123],
"icpIds": [123],
"labelIds": [123],
"unLabeledOnly": False,
"unTaggedOnly": False,
"employeePersonaIds": [123],
"startDate": 1717200000000,
"endDate": 1719792000000,
"listId": 123,
"page": 0,
"size": 50
}
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({
stageIds: [123],
icpIds: [123],
labelIds: [123],
unLabeledOnly: false,
unTaggedOnly: false,
employeePersonaIds: [123],
startDate: 1717200000000,
endDate: 1719792000000,
listId: 123,
page: 0,
size: 50
})
};
fetch('https://app.stairoids.com/api/public/v1/companies/ranked', 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/companies/ranked",
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([
'stageIds' => [
123
],
'icpIds' => [
123
],
'labelIds' => [
123
],
'unLabeledOnly' => false,
'unTaggedOnly' => false,
'employeePersonaIds' => [
123
],
'startDate' => 1717200000000,
'endDate' => 1719792000000,
'listId' => 123,
'page' => 0,
'size' => 50
]),
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/companies/ranked"
payload := strings.NewReader("{\n \"stageIds\": [\n 123\n ],\n \"icpIds\": [\n 123\n ],\n \"labelIds\": [\n 123\n ],\n \"unLabeledOnly\": false,\n \"unTaggedOnly\": false,\n \"employeePersonaIds\": [\n 123\n ],\n \"startDate\": 1717200000000,\n \"endDate\": 1719792000000,\n \"listId\": 123,\n \"page\": 0,\n \"size\": 50\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/companies/ranked")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"stageIds\": [\n 123\n ],\n \"icpIds\": [\n 123\n ],\n \"labelIds\": [\n 123\n ],\n \"unLabeledOnly\": false,\n \"unTaggedOnly\": false,\n \"employeePersonaIds\": [\n 123\n ],\n \"startDate\": 1717200000000,\n \"endDate\": 1719792000000,\n \"listId\": 123,\n \"page\": 0,\n \"size\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.stairoids.com/api/public/v1/companies/ranked")
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 \"stageIds\": [\n 123\n ],\n \"icpIds\": [\n 123\n ],\n \"labelIds\": [\n 123\n ],\n \"unLabeledOnly\": false,\n \"unTaggedOnly\": false,\n \"employeePersonaIds\": [\n 123\n ],\n \"startDate\": 1717200000000,\n \"endDate\": 1719792000000,\n \"listId\": 123,\n \"page\": 0,\n \"size\": 50\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
},
"windowedScore": 640
}
],
"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"
}