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

# CViewSurvey API

Jentic publishes the only available OpenAPI specification for CViewSurvey API, keeping it validated and agent-ready. CViewSurvey is a survey and customer-feedback platform aimed at offline and field-data collection alongside web-based surveys. The API exposes four endpoints for listing and creating surveys and for submitting and listing survey responses. Authentication is a single Authorization header API key, which makes it straightforward to wire into a feedback pipeline or a kiosk app.

## For AI agents

List and create CViewSurvey surveys, submit responses on behalf of respondents, and pull collected response data through four REST endpoints.

## Scope

Does not handle email delivery, full event analytics, or web tracking - use for survey definition and response submission via the CViewSurvey platform only.

## Capabilities

- List the surveys configured on the account via GET /surveys
- Create a new survey programmatically via POST /surveys
- Submit a respondent's answers to a survey via POST /responses
- Pull all responses collected to date via GET /responses
- Drive a kiosk or field-data app that posts responses on behalf of users
- Sync collected responses into a downstream warehouse or BI tool on a schedule

## Use cases

### Kiosk and field-data feedback collection

Drive a tablet kiosk or field-survey app that submits responses to CViewSurvey via POST /responses. Staff or respondents complete the form on the device and the app posts the answers in one call, with no manual data entry. The same surveys can also be served on the web for hybrid collection.

Example prompt: Submit a response to survey 42 with the answers payload from the kiosk and confirm a 200 response.

### Programmatic survey rollout

Stand up a campaign-specific survey from code so growth teams can iterate without using the dashboard. POST /surveys creates the survey definition, then a follow-up workflow embeds the survey URL into emails or in-app prompts. Responses come back in via GET /responses for analysis.

Example prompt: Create a survey titled 'Q3 NPS' with three questions and confirm it appears in GET /surveys.

### Analytics warehouse sync

Run a scheduled job that calls GET /responses, writes new rows into a BI warehouse, and feeds dashboards. Because the response surface is small, the integration is typically a thin script rather than a full ETL pipeline, and operators only need to handle pagination and an Authorization-header API key.

Example prompt: Pull all responses since yesterday from GET /responses and append them to the analytics.responses table.

### AI agent feedback collector via Jentic

Let an AI agent gather structured feedback inside a workflow - for example, after a support resolution. The agent searches Jentic for 'submit a survey response', loads the schema, and executes the POST without touching the API key. This is useful when an autonomous agent needs to capture and persist user input to a structured store.

Example prompt: Through Jentic, submit a response to survey 7 with the answers JSON returned by the chat flow.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/surveys` | List surveys on the account |
| POST | `/surveys` | Create a new survey |
| GET | `/responses` | List collected survey responses |
| POST | `/responses` | Submit a survey response |

## Key resources

- **Surveys** — List and create survey definitions
- **Responses** — List collected responses and submit new ones on behalf of respondents

## Why Jentic

- **Setup:** Wiring the CViewSurvey API by hand means provisioning an API key, passing it in the Authorization header, and formatting its survey and response request bodies yourself. Through Jentic you install once, import the CViewSurvey API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** CViewSurvey drives creation from the request body rather than a resource id in the URL path, so scope the agent to the operations it needs, such as listing surveys or submitting a response. If you grant only the read operations, creating surveys is not included unless you add it.
- **Credential handling:** Your CViewSurvey 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 'submit a survey response' or 'list surveys', and Jentic returns the matching CViewSurvey operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Typeform** — Polished web-first survey and form builder with rich integrations
- **SurveyMonkey** — Established survey platform with deep enterprise survey features
- **Jotform** — Form and survey builder with strong template library

## FAQ

### Why is there no official OpenAPI spec for CViewSurvey?

CViewSurvey does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CViewSurvey via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the CViewSurvey API use?

An API key passed in the Authorization header. Through Jentic, the key is stored encrypted in the vault and injected at execution time, so it never appears in agent prompts or logs.

### Can I create a survey programmatically with this API?

Yes. POST /surveys creates a new survey definition, and the same payload can carry questions and metadata. The survey then appears in GET /surveys for downstream tooling to embed or distribute.

### Can I submit responses on behalf of respondents?

Yes. POST /responses accepts a survey ID and an answers payload, which is what a kiosk app or chat-based collector typically uses to record a single completed response in one call.

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

Limits depend on your CViewSurvey plan rather than being declared in the spec. Watch for 429 responses, retry with backoff, and contact CViewSurvey support if your bulk-collection workload needs higher quotas.

### How do I submit a survey response through Jentic?

Run pip install jentic, search for 'submit a survey response', load the POST /responses schema, and execute with the survey ID plus answers JSON. Jentic returns the structured response without your code holding the API key.

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

Yes. Because you run Jentic One yourself, your own rules decide which CViewSurvey operations the agent may call, so you can grant only the read operations like listing surveys via GET /surveys or listing responses via GET /responses. Creation is driven from the request body rather than a resource id in the URL path, so if you scope the agent to reads alone it cannot create surveys with POST /surveys or submit responses with POST /responses unless you add those operations. Your API key is held by your own instance and injected only for the operations you allow, never exposed to the agent.