Skip to main content
POST
List visiting companies via API key

Authorizations

X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Headers

X-Whitelabel-Slug
string

Optional tenant context for admin-key operations without an organization target, such as creating an organization. Defaults to the master tenant. Must match an explicit target organization when both are supplied. Does not limit the key’s platform authority.

Required string length: 1 - 100
X-Organization-Id
string<uuid>

Target organization for admin-key requests on organization-context routes, including Data API, intent audiences and dashboard routes without an organization path parameter. Required on those routes. When supplied with an organization path parameter, both must identify the same organization; conflicting targets return 400. Does not grant access to customer credentials.

Body

application/json
window
enum<string>

Visit-time window; defaults to 30d when from/to are absent. Mutually exclusive with from/to.

Available options:
today,
24h,
3d,
7d,
14d,
30d,
mtd
Example:

"30d"

from
string<date-time>

Inclusive visit timestamp. Requires to; custom range maximum 366 days.

Example:

"2026-09-01T00:00:00Z"

to
string<date-time>

Exclusive visit timestamp. Requires from; future end is clamped to request time.

Example:

"2026-09-11T00:00:00Z"

timezone
string
default:UTC

IANA timezone used for calendar presets and daily time-series buckets; defaults to UTC.

Maximum string length: 100
Example:

"America/New_York"

classification
enum<string>
default:company

Dashboard view. Defaults to company, which includes company and unclassified_organization associations but excludes ISPs. Select isp for ISP associations only, or unclassified_organization for that subset only. Blank names and Unknown company placeholders are excluded from every view, ignoring case and surrounding whitespace. Response classification preserves the evidence classification, not the selected view. No company found results are not listed.

Available options:
company,
isp,
unclassified_organization
Example:

"company"

pixelIds
string<uuid>[]

Narrow to authorized pixels. Omitted means all pixels visible to this user; empty means no pixels.

Maximum array length: 100
search
string

Case-insensitive substring of company name or website.

Required string length: 1 - 200
linkedin
string

Case-insensitive substring of company LinkedIn URL.

Required string length: 1 - 500
industries
string[]
Maximum array length: 50
Required string length: 1 - 200
subIndustries
string[]
Maximum array length: 50
Required string length: 1 - 200
employeeMin
integer

Inclusive minimum employee count. Unknown counts are included only in the smallest band: employeeMax at most 50 and employeeMin omitted, 0 or 1.

Required range: 0 <= x <= 9007199254740991
Example:

10

employeeMax
integer

Inclusive maximum employee count; must not be below employeeMin. A maximum at most 50 with minimum omitted, 0 or 1 also includes unknown counts; returned counts remain null.

Required range: 0 <= x <= 9007199254740991
Example:

500

revenueRanges
string[]
Maximum array length: 50
Required string length: 1 - 200
countries
string[]
Maximum array length: 50
Required string length: 1 - 200
states
string[]
Maximum array length: 50
Required string length: 1 - 200
cities
string[]
Maximum array length: 50
Required string length: 1 - 200
pageHosts
string[]
Maximum array length: 50
Required string length: 1 - 200
pagePath
string
Required string length: 1 - 1000
page
integer
default:1
Required range: 1 <= x <= 1000
limit
integer
default:25
Required range: 1 <= x <= 100
sort
enum<string>
default:lastSeen
Available options:
lastSeen,
firstSeen,
events,
companyName
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

Matched companies and scoped activity counts.

data
object[]
required
pagination
object
required
meta
object
required