# Radar — Lua API Reference

## list_geofences

List geofences from Radar with optional filters for tag, group, and pagination.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `limit` | integer | no | Number of results to return (default: 100, max: 1000) |
| `cursor` | string | no | Pagination cursor from a previous response |
| `tag` | string | no | Filter geofences by tag |
| `group` | string | no | Filter geofences by group identifier |

### Example

```lua
local result = app.integrations.radar.list_geofences({
  limit = 50,
  tag = "store"
})

for _, geofence in ipairs(result.geofences) do
  print(geofence._id .. ": " .. geofence.description)
end
```

---

## get_geofence

Retrieve detailed information about a specific geofence by its ID.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `geofence_id` | string | yes | The unique identifier of the geofence to retrieve |

### Example

```lua
local result = app.integrations.radar.get_geofence({
  geofence_id = "5e523d5a91a0bc0046c1bdee"
})

local gf = result.geofence
print("Name: " .. gf.description)
print("Tag: " .. (gf.tag or "none"))
```

---

## create_geofence

Create a new geofence in Radar with a name, type, and geometry.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `name` | string | yes | The name of the geofence |
| `description` | string | no | A description of the geofence |
| `type` | string | no | The geofence type: `"circle"`, `"polygon"`, or `"isochrone"` |
| `coordinates` | string | no | GeoJSON coordinates or a center point (e.g. `"lat,lng"`) |
| `radius` | integer | no | Radius in meters (for circle geofences) |
| `tag` | string | no | A tag to categorize the geofence |
| `group` | string | no | A group identifier for the geofence |
| `external_id` | string | no | An optional external ID for mapping to your own records |
| `metadata` | object | no | Optional custom metadata key-value pairs |

### Example

```lua
local result = app.integrations.radar.create_geofence({
  name = "Downtown Store",
  description = "Flagship downtown store geofence",
  type = "circle",
  coordinates = "40.70390,-73.98970",
  radius = 200,
  tag = "store",
  group = "nyc"
})

print("Created geofence: " .. result.geofence._id)
```

---

## list_users

List users from Radar with optional filters for tags and pagination.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `limit` | integer | no | Number of results to return (default: 100, max: 1000) |
| `cursor` | string | no | Pagination cursor from a previous response |
| `tags` | string | no | Filter users by tags (comma-separated) |

### Example

```lua
local result = app.integrations.radar.list_users({
  limit = 25,
  tags = "driver"
})

for _, user in ipairs(result.users) do
  print(user._id .. ": " .. (user.description or "unnamed"))
end
```

---

## get_user

Retrieve detailed information about a specific Radar user by their ID.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `user_id` | string | yes | The unique identifier of the user to retrieve |

### Example

```lua
local result = app.integrations.radar.get_user({
  user_id = "5e523d5a91a0bc0046c1bdee"
})

local user = result.user
print("User: " .. user._id)
print("Location: " .. user.location.latitude .. ", " .. user.location.longitude)
```

---

## list_events

List events from Radar with optional filters for type, user, and pagination.

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `limit` | integer | no | Number of results to return (default: 100, max: 1000) |
| `cursor` | string | no | Pagination cursor from a previous response |
| `type` | string | no | Filter by event type, e.g. `"user.entered_geofence"`, `"user.exited_geofence"` |
| `user_id` | string | no | Filter events by user ID |
| `geofence_id` | string | no | Filter events by geofence ID |

### Example

```lua
local result = app.integrations.radar.list_events({
  limit = 50,
  type = "user.entered_geofence"
})

for _, event in ipairs(result.events) do
  print(event.type .. " at " .. event.createdAt)
  print("  User: " .. event.user._id)
  print("  Geofence: " .. event.geofence._id)
end
```

---

## get_current_user

Get the currently authenticated Radar user's account information.

### Parameters

This tool takes no parameters.

### Example

```lua
local result = app.integrations.radar.get_current_user({})

local user = result.user
print("Logged in as: " .. (user.description or user._id))
print("Email: " .. (user.email or "N/A"))
```

---

## Multi-Account Usage

```lua
-- Default account
app.integrations.radar.list_geofences({...})

-- Named accounts
app.integrations.radar.logistics.list_geofences({...})
app.integrations.radar.fleet.list_events({...})
```