Skip to main content
POST
List companies by funnel stage

Authorizations

X-Api-Key
string
header
required

Your organization's 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 with no Label attached (entries with tag=false); Tags don't count. OR-combines with labelIds.

Example:

false

unTaggedOnly
boolean

Only return companies with no Tag attached (entries with tag=true); Labels don't count. OR-combines with labelIds.

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