Skip to main content
GET
/
v1
/
radars
Get all radars
curl --request GET \
  --url https://api.tamradar.com/v1/radars \
  --header 'x-api-key: <api-key>'
{ "status": "success", "code": 200, "timestamp": "2024-03-20T10:15:30.000Z", "message": "Radars retrieved successfully", "count": 1, "limit": 50, "data": [ { "radar_id": "123e4567-e89b-12d3-a456-426614174000", "radar_type": "company_new_hires", "domain": "example.com", "created_at": "2024-03-20T10:00:00.000Z", "deactivated_at": null, "next_charge_at": "2024-04-20T10:00:00.000Z", "webhook_url": "https://example.com/webhook", "radar_status": "active", "custom_fields": { "department": "engineering" } } ] }

Documentation Index

Fetch the complete documentation index at: https://docs.tamradar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
radar_id
string

Comma-separated list of radar IDs (UUID format, max 50). Returns only the specified radars. Can be combined with other filters. Radar IDs that don't exist or don't belong to your account are silently excluded.

Example:

"uuid1,uuid2,uuid3"

​
limit
integer
default:50

Maximum number of radars to return. Leave empty to use the default value (50).

Required range: 1 <= x <= 1000
​
radar_type
enum<string>

Filter by radar type. Leave empty to return all types.

Available options:
company_new_hires,
company_job_openings,
company_promotions,
company_reviews,
company_mentions,
company_social_posts,
company_social_posts_cxo,
company_social_engagements,
contact_job_changes,
contact_social_posts,
contact_social_engagements,
industry_mentions,
industry_funding_rounds,
industry_new_companies,
industry_job_openings
​
radar_status
enum<string> | null

Filter by radar status. 'active' indicates the radar is operational, 'inactive' indicates it is not currently tracking or is in a grace period after deactivation.

Available options:
active,
inactive

Response

Successfully retrieved radars

​
status
enum<string>
Available options:
success
​
code
enum<integer>
Available options:
200
​
message
string
​
count
integer

Number of radars returned

​
limit
integer

Limit used for the request

​
data
object[]
​
timestamp
string<date-time>