canonical: https://jentic.com/apis/spotsense.io/spotsense-api

# SpotSense API

SpotSense provides a location-based engagement platform that enables developers to create geofences, beacons, and location-based rules to trigger actions when users enter or exit specific areas. The API supports managing geofences, beacon regions, rules, and retrieving location-based analytics. The API exposes 15 endpoints secured with apiKey, bearer authentication.

## For AI agents

Programmatically create geofence, list geofences. Covers 15 operations with apiKey, bearer authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Create Geofence
- List Geofences
- Get Geofence
- Update Geofence
- Delete Geofence

## Use cases

### CRM Operations

Use the SpotSense API to perform crm operations programmatically. The API provides 15 endpoints covering core functionality including create geofence, list geofences, get geofence.

Example prompt: Call POST `/apps/{appId}/geofences` to create geofence

### Automated Geofences Management

Automate geofences operations by combining multiple SpotSense API endpoints. Agents can list geofences and then get geofence in a single workflow.

Example prompt: Call GET `/apps/{appId}/geofences` to list geofences, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SpotSense API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, bearer tokens manually.

Example prompt: Search Jentic for 'create geofence', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/apps/{appId}/geofences` | Create Geofence |
| GET | `/apps/{appId}/geofences` | List Geofences |
| GET | `/apps/{appId}/geofences/{geofenceId}` | Get Geofence |
| PUT | `/apps/{appId}/geofences/{geofenceId}` | Update Geofence |
| DELETE | `/apps/{appId}/geofences/{geofenceId}` | Delete Geofence |
| POST | `/apps/{appId}/rules` | Create Rule |
| GET | `/apps/{appId}/rules` | List Rules |
| GET | `/apps/{appId}/rules/{ruleId}` | Get Rule |

## Key resources

- **Geofences** — Create and manage geofences (geographic boundaries)
- **Rules** — Create and manage location-triggered rules
- **Beacons** — Manage Bluetooth beacon regions
- **Apps** — Application management
- **Analytics** — Location analytics and event data

## Why Jentic

- **Setup:** Wiring the SpotSense API by hand means handling its API key and bearer auth and pointing every call at the api.spotsense.io/v1 host yourself. Through Jentic you install once, import the SpotSense API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** SpotSense puts the app and geofence ids in the URL path (`/apps/{appId}/geofences/{geofenceId}`), so a rule can pin your agent to one app and the reads within it. You choose the operations it may call, so destructive ones like deleting a geofence or a rule are not included unless you add them.
- **Credential handling:** Your SpotSense credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a geofence' or 'list rules for an app', and Jentic returns the matching SpotSense API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the SpotSense API use?

The SpotSense API uses apiKey, bearer authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create geofence with the SpotSense API?

Yes. Use the POST `/apps/{appId}/geofences` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SpotSense API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create geofence through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create geofence'. Jentic returns the matching SpotSense API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SpotSense API have?

The SpotSense API exposes 15 endpoints covering geofences, rules, beacons operations.

### Can I limit what my agent is allowed to do with the SpotSense API?

Yes. Because you run Jentic One yourself, your own rules decide which SpotSense operations and credentials the agent may use. Since SpotSense puts the app and geofence ids in the URL path, like `/apps/{appId}/geofences/{geofenceId}`, you can pin the agent to a single app and to reads within it. You choose the operations it may call, so destructive ones such as deleting a geofence or a rule stay out of reach unless you add them.