canonical: https://jentic.com/apis/customer.guru/customer-guru

# Customer.guru API

Jentic publishes the only available OpenAPI specification for Customer.guru API, keeping it validated and agent-ready. Customer.guru is a Net Promoter Score (NPS) measurement tool that helps teams send survey emails, schedule recurring NPS programmes, and export rating and customer data. The compact API exposes survey send/scheduling, customer export, and ratings export endpoints. The spec defines no security scheme; in practice authentication is handled by an account-specific URL or token configured on the vendor side.

## For AI agents

Send and schedule NPS surveys to customers, export rated customer lists, and pull NPS rating history for analysis or downstream reporting.

## Scope

Does not handle CSAT or CES surveys, ticketing, or general customer support - use for NPS survey sending and rating export only.

## Capabilities

- Send a one-off NPS survey to a single customer or schedule recurring sends
- Export the list of customers who have received or responded to surveys
- Export NPS rating history with associated customer identifiers and timestamps
- Trigger NPS programmes from product events (signup, renewal, support resolution)

## Use cases

### Post-Event NPS Trigger

Trigger an NPS survey at a meaningful customer moment such as renewal, support ticket close, or onboarding completion. The `/api/v2/survey` endpoint accepts a customer email and metadata so product or CS teams can send context-aware surveys without manual list management. Suitable for SaaS teams who want NPS tied to lifecycle events rather than calendar windows.

Example prompt: Call POST `/api/v2/survey` with the customer email after a renewal event so an NPS survey is sent with the renewal context attached

### NPS Data Export to BI

Pull NPS rating history into a data warehouse or BI tool for cohort analysis, score trends, and correlation with other product metrics. Use GET `/export/ratings` to retrieve the rating dataset and GET `/export/customers` for the customer dimension, then load both into a destination warehouse on a daily schedule.

Example prompt: Call GET `/export/ratings` on a daily schedule and load the result into a warehouse table for trend analysis against churn and retention

### Scheduled NPS Programme

Set up a recurring NPS programme where surveys are sent on a defined cadence (e.g. every 90 days post-signup). Use the `/api/v2/survey` endpoint with scheduling parameters so cohorts are surveyed automatically without engineering needing to maintain a cron job or queue.

Example prompt: Call POST `/api/v2/survey` with a schedule_at parameter for 90 days from signup to enrol the customer in a recurring NPS programme

### AI Agent NPS Workflow via Jentic

An AI agent automating customer success workflows uses Jentic to send and analyse NPS surveys without the developer wiring up Customer.guru directly. The agent searches for 'send nps survey', loads the operation schema, supplies the customer record, and triggers the send.

Example prompt: Use Jentic to search 'send nps survey' and execute `/api/v2/survey` for each customer in a batch from a CSV upload

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v2/survey` | Send or schedule an NPS survey |
| GET | `/export/customers` | Export the customer list |
| GET | `/export/ratings` | Export NPS rating responses |

## Key resources

- **Surveys** — Send and schedule NPS surveys to customers
- **Customers** — Export the customer list known to the Customer.guru account
- **Ratings** — Export NPS rating responses for analysis and reporting

## Why Jentic

- **Setup:** Wiring Customer.guru by hand means figuring out its account setup, formatting the survey and export request bodies, and handling its responses yourself. Through Jentic you install once, import the Customer.guru API from the API Directory, store the account credential once, and your agent calls it.
- **Permission scoping:** Customer.guru carries the survey target in the request body rather than the URL path, so scope the agent to the operations it needs, such as sending an NPS survey or exporting ratings. If you grant only the export reads, survey sending is not included unless you add it.
- **Credential handling:** Your Customer.guru 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 'send an NPS survey' or 'export customer ratings', and Jentic returns the matching Customer.guru operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **SurveyMonkey API** — General survey platform with broader question types beyond NPS
- **Typeform API** — Conversational form and survey platform with embeddable forms
- **Qualtrics API** — Enterprise experience management platform including NPS at scale

## FAQ

### Why is there no official OpenAPI spec for Customer.guru API?

Customer.guru does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Customer.guru 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 Customer.guru API use?

The published spec does not declare a security scheme; in practice Customer.guru uses an account-specific URL or token configured on the vendor side. Through Jentic any required token is held in the encrypted vault and injected at call time.

### Can I send NPS surveys with the Customer.guru API?

Yes. Call POST `/api/v2/survey` with the customer email and any scheduling parameters. The endpoint covers both immediate sends and scheduled or recurring sends.

### What are the rate limits for the Customer.guru API?

Rate limits are governed by the Customer.guru plan and are not encoded in the spec. Export endpoints are typically intended for low-frequency batch use rather than high-rate polling.

### How do I export NPS rating data through Jentic?

Run pip install jentic, search for 'export ratings', load GET `/export/ratings`, and execute it. Jentic returns the rating dataset for ingest into a warehouse or BI tool.

### How do I retrieve the list of customers in the account?

Call GET `/export/customers.` The response contains the customer records known to the Customer.guru account, suitable for joining against `/export/ratings` on the customer identifier.

### Can I limit what my agent is allowed to do with the Customer.guru API?

Yes. Because you run Jentic One yourself, your own rules decide which Customer.guru operations and credentials the agent may use. You can grant read-only access to GET `/export/customers` and GET `/export/ratings` while withholding POST `/api/v2/survey`, so the agent can pull customer and NPS rating data without being able to send or schedule surveys. If you later want the agent to send surveys, you add that operation to its allowed set explicitly.