canonical: https://jentic.com/apis/sightmap.com/sightmap

# SightMap® REST API

Introduction The SightMap® API uses standard HTTP verbs to communicate and HTTP status codes to indicate status and errors. All responses come in standard JSON. The SightMap API is served over HTTPS to ensure data privacy; HTTP is not supported. Versioning Versions are communicated as `VERSION.RELEASE-DATE`, where `VERSION` denotes the version number of the API and prefixed to all API request path. The API exposes 88 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list accounts, view an account. Covers 88 operations with apiKey authentication.

## Scope

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

## Capabilities

- List accounts
- View an account
- Assign assets
- Unassign assets
- Monitor SightMap® REST API operational status and events

## Use cases

### CRM Operations

Use the SightMap® REST API to perform crm operations programmatically. The API provides 88 endpoints covering core functionality including list accounts, view an account, list embeds.

Example prompt: Call GET /accounts to list accounts

### Automated assets/filters Management

Automate assets/filters operations by combining multiple SightMap® REST API endpoints. Agents can view an account and then list embeds in a single workflow.

Example prompt: Call GET `/accounts/{account}` to view an account, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SightMap® REST 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 tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/accounts` | List accounts |
| GET | `/accounts/{account}` | View an account |
| GET | `/accounts/{account}/embeds` | List embeds |
| GET | `/accounts/{account}/embeds/{embed}` | View an embed |
| GET | `/accounts/{account}/assets` | List assets |
| PUT | `/accounts/{account}/assets` | Assign assets |
| PUT | `/accounts/{account}/assets/remove` | Unassign assets |
| POST | `/assets` | Create an asset |

## Key resources

- **assets/filters** — Operations related to assets/filters
- **assets/units/descriptions** — Operations related to assets/units/descriptions
- **assets/pricing** — Operations related to assets/pricing
- **assets/maps** — Operations related to assets/maps
- **assets/units/outbound-links** — Operations related to assets/units/outbound-links

## Why Jentic

- **Setup:** Wiring SightMap by hand means sending its API-Key header, pointing calls at https://api.sightmap.com/v1, and threading account and embed ids through yourself. Through Jentic you install once, import SightMap from the API Directory, store the API-Key once, and your agent calls it.
- **Permission scoping:** SightMap puts the account id in the URL path (`/accounts/{account}`), so a rule can pin your agent to one account: it can read that account's embeds and assets and nothing else. You choose the operations it may call, so writes like updating or removing assets are not included unless you add them.
- **Credential handling:** Your SightMap API-Key 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 'list accounts' or 'get an account's embeds', and Jentic returns the matching SightMap 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 SightMap® REST API use?

The SightMap® REST API uses an API key passed in the `API-Key` header. 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 list accounts with the SightMap® REST API?

Yes. Use the GET /accounts endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SightMap® REST 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 list accounts through Jentic?

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

### How many endpoints does the SightMap® REST API have?

The SightMap® REST API exposes 88 endpoints covering assets/filters, assets/units/descriptions, assets/pricing operations.

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

Yes. SightMap puts the account id in the URL path (`/accounts/{account}`), so in your self-hosted Jentic One instance you can write a rule that pins your agent to a single account, letting it read only that account's embeds and assets. Because you decide which operations the agent may call, write operations such as assigning or unassigning assets stay off limits unless you explicitly add them. Your API key is stored by your own Jentic One instance and injected at execution time, so the agent only ever exercises the operations and account you have permitted.