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

# Surveypal API

Surveypal RESTful API for managing surveys, answers, email tasks, and short URLs. The API exposes 28 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list all surveys, get a specific survey. Covers 28 operations with apiKey authentication.

## Scope

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

## Capabilities

- List all surveys
- Get a specific survey
- Preview a survey
- Query and filter Surveypal API records by parameters
- Monitor Surveypal API operational status and events

## Use cases

### Communications Operations

Use the Surveypal API to perform communications operations programmatically. The API provides 28 endpoints covering core functionality including list all surveys, get a specific survey, get answer count for a survey.

Example prompt: Call GET /surveys to list all surveys

### Automated Answers Management

Automate answers operations by combining multiple Surveypal API endpoints. Agents can get a specific survey and then get answer count for a survey in a single workflow.

Example prompt: Call GET `/survey/{id}` to get a specific survey, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Surveypal 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 all surveys', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/surveys` | List all surveys |
| GET | `/survey/{id}` | Get a specific survey |
| GET | `/survey/{id}/answer/count` | Get answer count for a survey |
| GET | `/survey/{id}/elements` | Get survey elements |
| GET | `/survey/{id}/merges` | Get survey merge data |
| GET | `/survey/{id}/languages` | List survey languages |
| GET | `/survey/{id}/preview` | Preview a survey |
| GET | `/survey/{id}/answers` | Get survey answers |

## Key resources

- **Answers** — Operations related to Answers
- **Email Tasks** — Operations related to Email Tasks
- **Invitations** — Operations related to Invitations
- **Short URLs** — Operations related to Short URLs
- **Surveys** — Operations related to Surveys

## 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:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/surveypal.com/surveypal/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 the Surveypal API by hand means passing its API key against api.surveypal.com and managing retries yourself. Through Jentic you install once, import the Surveypal API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Surveypal API puts the survey id in the URL path (`/survey/{id}/...`), so a rule can pin your agent to one survey: it can read that survey's elements, answers, and languages and nothing else. Every operation here is a read, so the agent only ever fetches data you allow it to reach.
- **Credential handling:** Your Surveypal 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 all surveys' or 'read a survey's answers', and Jentic returns the matching Surveypal API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Surveypal API use?

The Surveypal API uses an API key passed in the `Authorization` 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 all surveys with the Surveypal API?

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

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

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

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

The Surveypal API exposes 28 endpoints covering answers, email tasks, invitations operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Surveypal API operations and credentials your agent may use. Since the API puts the survey id in the URL path (`/survey/{id}/...`), you can pin the agent to a single survey so it only reads that survey's elements, answers, and languages and nothing else. Every operation here is a read, so the agent can only fetch the survey data you allow it to reach.