canonical: https://jentic.com/apis/smartsurvey.io/smartsurvey

# SmartSurvey API

SmartSurvey API provides access to survey data, from listing all surveys to getting all the responses for a survey. It supports managing surveys, responses, contact lists, invitations, tracking links, themes, webhooks, and more. The API exposes 84 endpoints secured with basic authentication.

## For AI agents

Programmatically get all, get by id. Covers 84 operations with basic authentication.

## Scope

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

## Capabilities

- Get All
- Insert
- Update
- Query and filter SmartSurvey API records by parameters
- Monitor SmartSurvey API operational status and events

## Use cases

### CRM Operations

Use the SmartSurvey API to perform crm operations programmatically. The API provides 84 endpoints covering core functionality including get all, get by id, get details for key.

Example prompt: Call GET /accountusers to get all

### Automated Account Management

Automate account operations by combining multiple SmartSurvey API endpoints. Agents can get by id and then get details for key in a single workflow.

Example prompt: Call GET `/accountusers/{account_user_id}` to get by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SmartSurvey 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 basic tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/accountusers` | Get All |
| GET | `/accountusers/{account_user_id}` | Get By Id |
| GET | `/accountuser` | Get Details for Key |
| POST | `/account/apikeys` | Insert |
| GET | `/account/apikeys` | Get All |
| GET | `/account/apikeys/{apiKeyId}` | Get By Id |
| PUT | `/account/apikeys/{apiKeyId}` | Update |
| DELETE | `/account/apikeys/{apiKeyId}` | Delete |

## Key resources

- **Account** — Operations for account
- **Accountuser** — Operations for accountuser
- **Accountusers** — Operations for accountusers
- **Contactlists** — Operations for contactlists
- **Filelibrary** — Operations for filelibrary

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 40 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 98 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 55 / 100
  - Agent Usability: 88 / 100
  - Security: 10 / 100
  - AI Discoverability: 56 / 100
- **View full report:** https://jentic.com/apis/smartsurvey.io/smartsurvey/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring SmartSurvey by hand means handling its basic auth against api.smartsurvey.io and managing retries yourself. Through Jentic you install once, import the SmartSurvey API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** SmartSurvey puts the resource id in the URL path (`/accountusers/{account_user_id}`, `/account/apikeys/{apiKeyId}`), so a rule can pin your agent to reads on account users and API keys. You choose the operations it may call, so deleting or updating an API key is not included unless you add it.
- **Credential handling:** Your SmartSurvey 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 'list account users' or 'read an API key', and Jentic returns the matching SmartSurvey 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 SmartSurvey API use?

The SmartSurvey API uses HTTP Basic authentication with username and password. 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 get all with the SmartSurvey API?

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

### What are the rate limits for the SmartSurvey 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 get all through Jentic?

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

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

The SmartSurvey API exposes 84 endpoints covering account, accountuser, accountusers operations.

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

Yes. Jentic One is self-hosted, so you run your own instance and your own rules decide which SmartSurvey operations and credentials the agent may use. Because SmartSurvey puts the resource id in the URL path, such as `/accountusers/{account_user_id}` and `/account/apikeys/{apiKeyId}`, you can pin the agent to reads on account users and API keys and leave out the operations that delete or update an API key. Only the endpoints you explicitly allow are callable, so a write like removing an API key is excluded unless you add it.