Skip to main content
POST
Create a company radar

Authorizations

x-api-key
string
header
required

Body

application/json
domain
string
required

The domain to track (e.g., stripe.com). Protocol, www, paths, and query parameters are automatically normalized.

Example:

"stripe.com"

radar_type
enum<string>
required

The type of company activity to track

Available options:
company_new_hires,
company_job_openings,
company_promotions,
company_reviews,
company_mentions,
company_social_posts,
company_social_posts_cxo,
company_social_engagements
webhook_url
string<uri>

Webhook URL to receive radar updates and notifications. Optional — if omitted, the radar is poll-only and updates are available via GET /v1/updates.

Example:

"https://webhook.site/your-webhook-id"

updates_since
string<date-time>

Optional RFC 3339 timestamp with a UTC offset defining the earliest eligible source event. TAMradar normalizes and stores the value in UTC. It must represent now or a past instant and may be at most five calendar years old. A five-second server tolerance exists only for clock skew; it is not future scheduling. When omitted, the radar creation timestamp is used as the effective cutoff.

include_historical
boolean
deprecated

Deprecated compatibility field. It is accepted and stored but has no effect. Use updates_since to request historical eligibility.

departments
string[]

Optional array of department names to filter results. See API documentation for valid department values.

Example:
seniorities
string[]

Optional array of seniority levels to filter results. See API documentation for valid seniority values.

Example:
job_titles
string

Boolean expression filtering company radar results by job title. When provided, job_titles takes precedence over departments and seniorities; those fields do not affect matching. Operators AND, OR, and NOT must be uppercase. A single word may be unquoted; multi-word phrases must use double quotes. Matching is case-insensitive for title terms. A quoted phrase means contiguous phrase containment within the candidate title, not exact whole-title equality: "Marketing Manager" matches "Senior Marketing Manager" but not "Marketing Operations Manager". EXACT("Marketing Manager") requires the complete normalized title to equal "Marketing Manager"; it does not match "Senior Marketing Manager" and does not expand aliases or abbreviations. EXACT must be uppercase and requires exactly one double-quoted title. Operator precedence is NOT, then AND, then OR; parentheses control grouping. Each term must contain at least two searchable characters and may contain at most 100 characters. The complete expression may contain at most 9,000 characters and 32 nested Boolean groups. A malformed expression returns HTTP 400 with an actionable job_titles error.

Example:

"EXACT(\"Sales Operations Manager\") OR (\"sales operations\" AND (manager OR VP))"

custom_fields
object

Optional metadata to attach to this radar. Values must be strings only. Use for internal tracking like account_id, customer_id, or campaign_id. Returned with every webhook.

Example:
profile_url
string<uri>

LinkedIn company or school page URL. Must be exact format: https://www.linkedin.com/company/acme or https://www.linkedin.com/school/stanford-university

Example:

"https://www.linkedin.com/company/stripe"

Response

Radar created successfully

status
enum<string>
Available options:
success
code
enum<integer>
Available options:
201
message
string
data
object
timestamp
string<date-time>