Skip to main content
POST
Search companies or people

Query Parameters

view
enum<string>
default:account
Available options:
account,
contact,
swarm_contact
current_page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: 1 <= x <= 500

Body

application/json

The public Search input. grouping_rule and max_candidates are not offered: Search never applied either (sources/tam.py), so the public schema refuses them (422) rather than accept and ignore them.

filtering_rules
searching_rule
TamSearchRule · object | null
sorting_rules
TamSortRule · object[]
query_id
string<uuid> | null

The query_id a previous page of this search returned, echoed back with the same criteria to page, or a saved TAM search config UUID. Authorized when saved; never applied as a filter source.

exclude_companies_in_tam
boolean
default:false
title_enrichment
TamTitleEnrichment · object | null
with_titles
boolean
default:false
account_view_id
string<uuid> | null

Response

Successful Response

data
TamSearchResponse · object
required
meta
ResponseMeta · object