canonical: https://jentic.com/apis/goodreviews.io/goodreviews-io

# GoodReviews API

Jentic publishes the only available OpenAPI specification for GoodReviews API, keeping it validated and agent-ready. The GoodReviews API exposes a single endpoint, POST `/api/zapier/campaign/single`, that sends a Google review invitation to one customer in a configured campaign. It is the integration point for Zapier and similar tools, with an X-APIKEY header and a payload that supplies the campaign ID and the customer's contact details. Although hosted on api.goodreviews.com, this surface is documented at the goodreviews.io domain.

## For AI agents

Send a single Google review invitation via the one POST endpoint exposed by the goodreviews.io campaign API.

## Scope

Does not handle review monitoring, automated review responses, sentiment analysis, or non-Google review platforms - use for sending a single Google review invitation tied to a configured GoodReviews campaign only.

## Capabilities

- Send one Google review invitation against a configured campaign
- Wire a review request into a Zapier or Make automation
- Pass campaign ID and customer contact details into a single POST
- Authenticate every call with one X-APIKEY token
- Trigger an invitation from any system that can call HTTPS

## Use cases

### Zapier-Wired Review Requests

Small businesses on goodreviews.io fire one review invitation per customer transaction by mapping a Zapier trigger to POST `/api/zapier/campaign/single.` The pattern fits e-commerce checkout, scheduling tools, and CRMs equally and requires no server code.

Example prompt: Map a Shopify 'order fulfilled' Zap trigger to POST `/api/zapier/campaign/single` with campaign id cmp_42 and the customer's email.

### Programmatic Single-Customer Send

Backend services that want to bypass Zapier call the same endpoint directly with the X-APIKEY header. Because there is only one operation, integration is short - handle the auth header, post the JSON, and check the response code.

Example prompt: POST a campaign invitation for campaign cmp_renewals to the customer who renewed their subscription this morning.

### AI Agent Review Step via Jentic

An AI agent that already coordinates customer follow-up sequences adds GoodReviews as one more step through Jentic. Because the spec is jentic-generated, the agent's MCP tool catalog has a single, validated GoodReviews operation it can call without docs.

Example prompt: After a positive support resolution, send a GoodReviews invitation for campaign cmp_csat to the customer's email.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/zapier/campaign/single` | Send a single campaign invitation |

## Key resources

- **Campaigns** — Send a single Google review invitation tied to a campaign

## Why Jentic

- **Setup:** Wiring GoodReviews by hand means passing the X-APIKEY header against api.goodreviews.com and building the single-invitation request body for a configured campaign yourself. Through Jentic you install once, import GoodReviews from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** GoodReviews exposes a single POST `/api/zapier/campaign/single` operation, so the agent's scope is that one operation: sending a Google review invitation tied to a configured campaign. You choose whether the agent may call it, and no other operation is reachable.
- **Credential handling:** Your GoodReviews 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 'send a google review invitation', and Jentic returns the GoodReviews POST `/api/zapier/campaign/single` operation with its input schema so the agent calls the right endpoint without reading the reference.

## Related APIs

- **GoodReviews API (.com)** — The .com domain documents the same single campaign-invitation endpoint.
- **Reply Reviews** — Review request and management with broader response and analytics features.
- **ClickSend** — Custom SMS reminders around a GoodReviews invitation.

## FAQ

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

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

The API uses an X-APIKEY header (apiKey scheme) issued per GoodReviews account. Through Jentic the key is stored encrypted in the vault and scoped to that account, so the raw key never enters the agent's context.

### Can I send a review invitation with one call to the goodreviews.io API?

Yes. POST `/api/zapier/campaign/single` accepts the campaign ID and customer contact details, and GoodReviews handles the rest of the delivery. The base URL is api.goodreviews.com even though the documentation lives under goodreviews.io.

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

GoodReviews applies per-account rate limits sized for Zapier-style traffic. The OpenAPI spec does not encode exact numbers, so check the GoodReviews dashboard before running large historical sends - bulk runs should use a queued automation rather than a tight loop.

### How do I trigger an invitation through Jentic?

Search Jentic for 'send a goodreviews invitation', load the schema for POST `/api/zapier/campaign/single`, and execute with the campaign ID and customer's email. Jentic injects the X-APIKEY at execution so the agent only handles the campaign and contact fields.

### Does this API support replying to existing reviews?

No. The single endpoint only sends invitations. For monitoring and responding to reviews, pair with a review-management platform such as Reply Reviews or use the Google Business Profile API directly.

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

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. The GoodReviews API exposes a single operation, POST `/api/zapier/campaign/single`, which sends a Google review invitation tied to a configured campaign, so you decide whether the agent may call that one operation and no other action is reachable. Your GoodReviews API key stays with your Jentic One instance and is injected at execution, so the agent handles only the campaign ID and customer contact details.