Skip to main content
GET
/
v1
/
radars
/
{radar_id}
Get a specific radar
curl --request GET \
  --url https://api.tamradar.com/v1/radars/{radar_id} \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "code": 200,
  "timestamp": "2024-03-20T10:15:30.000Z",
  "message": "Radar retrieved successfully",
  "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://your-webhook.com/endpoint",
    "radar_status": "active",
    "custom_fields": {
      "department": "engineering",
      "notes": "Track engineering hires"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
radar_id
string<uuid>
required

The unique identifier of the radar

Response

Radar found and returned successfully

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