Skip to main content
POST
/
public
/
v1
/
companies
/
by-funnel-stage
List companies by funnel stage
curl --request POST \
  --url http://app.stairoids.com/api/public/v1/companies/by-funnel-stage \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "stageIds": [
    123
  ],
  "listId": 123,
  "icpIds": [
    123
  ],
  "labelIds": [
    123
  ],
  "unLabeledOnly": false,
  "page": 0,
  "size": 20
}
'
{
  "data": [
    {
      "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
    }
  ],
  "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 companies by funnel stage (and optional list / ICP / label filters).

stageIds
integer<int64>[]

Funnel-stage ids to include (see GET /public/v1/funnel/stages). Empty = all stages.

Funnel-stage ids to include (see GET /public/v1/funnel/stages). Empty = all stages.

listId
integer<int64>

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

icpIds
integer<int64>[]

Restrict to these ICP ids. Null or empty = all ICPs.

Restrict to these ICP ids. Null or empty = all ICPs.

labelIds
integer<int64>[]

Restrict to these label ids. Null or empty = all labels.

Restrict to these label ids. Null or empty = all labels.

unLabeledOnly
boolean

Only return companies that have no labels.

Example:

false

page
integer<int32>
default:0

Zero-based page index.

Example:

0

size
integer<int32>
default:20

Page size (clamped to 100).

Example:

20

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