canonical: https://jentic.com/apis/captureiq.ai/captureiq

# CaptureIQ API

Jentic publishes the only available OpenAPI specification for CaptureIQ API, keeping it validated and agent-ready. CaptureIQ is a forms and submissions platform, and its REST API exposes a small but practical surface: validate a configured API key and retrieve the most recent submission across the account. The spec is currently in beta, so the published surface is intentionally narrow while the platform expands to more form management endpoints. Operations teams use it to verify integrations and to poll for the latest inbound submission inside automation workflows.

## For AI agents

Validate a CaptureIQ API key and pull the most recent form submission across the account. Suited for integration health checks and lightweight inbound polling.

## Scope

Does not handle form creation, full submission history, or webhooks - use for API key validation and recent submission retrieval only.

## Capabilities

- Validate that a configured CaptureIQ API key is active and authorised
- Retrieve the most recent form submission across the account in a single call
- Poll for new inbound submissions in workflow tools without managing webhooks
- Confirm an integration is connected before running a wider automation step
- Use as a smoke-test endpoint when adding CaptureIQ to a new pipeline

## Use cases

### Integration Health Check

Before kicking off a longer automation, a workflow tool calls GET /api/validateApiKey to confirm the configured CaptureIQ token is still valid. The call returns success or an error and acts as a single-shot probe that prevents downstream steps from running with stale credentials.

Example prompt: GET /api/validateApiKey with the configured bearer token and abort the workflow if the response is not 200.

### Inbound Submission Polling

Where webhooks are not viable, automations poll GET /ciq/recent-submission/v1 every minute or so to fetch the latest submission and forward it to a CRM, ticketing tool, or analytics warehouse. Because the endpoint returns the most recent submission, the integration deduplicates by submission id on its side.

Example prompt: Every minute, GET /ciq/recent-submission/v1, dedupe by submission id, and forward new entries to the CRM.

### Pre-Send Connectivity Probe

Tools that orchestrate a sequence of vendor calls run a quick probe against CaptureIQ before invoking any side-effecting steps. validateApiKey is a low-cost call that surfaces auth or network issues early so the rest of the run can fail fast with a clear cause.

Example prompt: GET /api/validateApiKey at workflow start, log the result, and proceed only if the call succeeds.

### AI Agent Submission Triage

An agent that triages inbound form submissions uses CaptureIQ via Jentic to fetch the latest entry and classify it into the right downstream queue. It searches for the recent-submission operation, loads the schema, and executes the call - credentials stay encrypted in your Jentic One instance.

Example prompt: Search Jentic for 'get the latest CaptureIQ submission', load the recentSubmission schema, and execute GET /ciq/recent-submission/v1 in the agent's poll loop.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/validateApiKey | Validate that the bearer token is active |
| GET | /ciq/recent-submission/v1 | Retrieve the most recent form submission |

## Key resources

- **API** — Validate API keys for connectivity and auth checks
- **Ciq** — Retrieve recent submissions from the CaptureIQ platform

## Why Jentic

- **Setup:** Wiring the CaptureIQ API by hand means issuing a JWT bearer token, sending it in the Authorization header on every request, and calling the app.captureiq.ai host yourself. Through Jentic you install once, import the CaptureIQ API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** CaptureIQ exposes two read operations, so you scope by operation: limit the agent to the ones it needs, such as validating the API key or fetching the most recent submission, and it can do nothing beyond the set you allow.
- **Credential handling:** Your CaptureIQ bearer JWT is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'validate a CaptureIQ API key' or 'get the latest CaptureIQ submission', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Cantrip API** — Form submission listing and webhook subscriptions in a CMS context
- **Canny API** — Capture structured product feedback alongside CaptureIQ form submissions
- **Captivated Messaging API** — Send an SMS follow-up when a CaptureIQ submission lands

## FAQ

### Why is there no official OpenAPI spec for CaptureIQ API?

CaptureIQ is in beta and publishes a help-site reference but not an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CaptureIQ API 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 CaptureIQ API use?

CaptureIQ uses bearer JWT authentication. The token is sent as Authorization: Bearer <token>. Through Jentic the token is stored encrypted in the vault and injected at execution time, so it never enters the agent's prompt context.

### Can I retrieve recent submissions with the CaptureIQ API?

Yes. GET /ciq/recent-submission/v1 returns the most recent submission across the account. Dedupe by submission id when polling so the same entry is not processed twice.

### How do I check whether my CaptureIQ token is still valid through Jentic?

Search Jentic for 'validate CaptureIQ API key', load the validateApiKey operation, and execute GET /api/validateApiKey. A 200 response means the token is active.

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

The OpenAPI spec does not enumerate rate limits while the API is in beta. Treat as low volume - poll the recent-submission endpoint at most once per minute and back off on 429 responses.

### Does CaptureIQ support webhooks for new submissions?

The current beta surface only exposes the validate and recent-submission endpoints. Until a webhook is published, polling /ciq/recent-submission/v1 is the supported way to detect new entries.

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

Yes. Because Jentic One is self-hosted, you set the rules that decide which operations and credentials your agent may use. The CaptureIQ API exposes only two read operations, so you scope by operation: allow the agent to validate the API key (GET /api/validateApiKey), to fetch the most recent submission (GET /ciq/recent-submission/v1), or just one of them. The agent can do nothing beyond the set you allow, and your bearer token stays with your own instance rather than in the agent's prompt.