Skip to main content
POST
/
public
/
v1
/
companies
/
ranked
Rank companies by intent score
curl --request POST \
  --url http://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,
  "employeePersonaIds": [
    123
  ],
  "startDate": 1717200000000,
  "endDate": 1719792000000,
  "listId": 123,
  "page": 0,
  "size": 50
}
'
{
  "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
          }
        ],
        "latestActivityTimestamp": 1719500000000
      },
      "windowedScore": 640
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 137,
  "totalPages": 7
}

Authorizations

X-Api-Key
string
header
required

Your organization's public API key. Manage it at GET /api/user/public-api-key.

Body

application/json

Filter + time window for the cool-score (time-windowed) ranking.

stageIds
integer<int64>[]

Funnel stage ids to include. Empty = all stages.

Funnel stage ids to include. Empty = all stages.

icpIds
integer<int64>[]

ICP ids to include. Empty = all ICPs.

ICP ids to include. Empty = all ICPs.

labelIds
integer<int64>[]

Label ids to include. Empty = all labels.

Label ids to include. Empty = all labels.

unLabeledOnly
boolean

Return only companies with no labels.

Example:

false

employeePersonaIds
integer<int64>[]

Employee-persona ids to restrict to. Empty = no persona filter.

Employee-persona ids to restrict to. Empty = no persona filter.

startDate
integer<int64>

Window start, epoch millis. Omit both startDate and endDate to rank by stored all-time score.

Example:

1717200000000

endDate
integer<int64>

Window end, epoch millis.

Example:

1719792000000

listId
integer<int64>

Restrict to a single account-list id. Null = all lists.

page
integer<int32>
default:0

Zero-based page index.

Example:

0

size
integer<int32>
default:50

Page size (clamped to 100).

Example:

50

Response

OK

A page of results.

data
object[]

The items on this page.

page
integer<int32>

Zero-based page index.

Example:

0

size
integer<int32>

Requested page size.

Example:

20

totalElements
integer<int64>

Total number of matching items across all pages.

Example:

137

totalPages
integer<int32>

Total number of pages.

Example:

7