FiveStars API

Name: FiveStars API
Brand: FiveStars API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingMarketing Automationoauth25 EndpointsREST

For Agents

Trigger FiveStars review-request emails for customers and list available review campaigns over OAuth 2.0.

Connect the FiveStars API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the FiveStars API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with FiveStars API.

Complete the OAuth 2.0 authorization code exchange to obtain a FiveStars access token

Verify whether a stored FiveStars token is still valid before sending a request

List all review campaigns configured on a FiveStars account

Send a review-request email to a customer by name, email, and campaign ID

GET STARTED

Start building with FiveStars API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for FiveStars API, keeping it validated and agent-ready. FiveStars exposes a small Zapier-oriented REST API for managing review campaigns and triggering review-request emails after a customer interaction. The five endpoints cover the OAuth 2.0 authorization code flow, a token validity check, listing campaigns, and submitting a review request for a contact. It is a focused, narrow integration designed for connecting external systems to a FiveStars review workflow.

Use Cases

Patterns agents use FiveStars API for, with concrete tasks.

★ Post-Transaction Review Request

Send a FiveStars review request the moment a transaction completes in a POS or e-commerce system. The integration calls POST /api/zapier/review-request with the customer's first name, last name, email, and the campaign ID returned by GET /api/zapier/campaigns. Setup is a few hours once the OAuth client is registered.

Call POST /api/zapier/review-request with email=customer@example.com, firstName=Jane, lastName=Doe, and campaignId from a prior GET /api/zapier/campaigns response.

OAuth Connection Health Check

Run a periodic background job that calls GET /api/zapier/test to confirm the stored FiveStars OAuth token still authenticates. If the call returns a 401, the system surfaces a reconnection prompt to the user before the next review request would silently fail. This avoids losing review opportunities mid-campaign.

Call GET /api/zapier/test with the stored FiveStars Bearer token and surface a reconnect prompt if the response code is 401.

Campaign Picker for CRM Integrations

Render a dropdown of FiveStars campaigns inside a CRM so that staff can choose which review flow to use for each contact segment. The integration calls GET /api/zapier/campaigns once per session and caches the campaign IDs. This gives users a low-friction way to route different customer types into different review templates.

Call GET /api/zapier/campaigns and return a JSON list of campaign id and name pairs for the connected merchant.

AI Agent Review Request Trigger

An AI agent hooked into a service business's calendar uses Jentic to fire a FiveStars review request after every completed appointment. It searches for the right operation, loads the schema, and submits the request without the developer wiring up the OAuth flow manually. Time-to-first-review-sent drops from days to under an hour.

Search Jentic for 'send a FiveStars review request', load the schema, and submit a request for the customer attached to the most recent completed appointment.

Key Endpoints

5 endpoints — jentic publishes the only available openapi specification for fivestars api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/api/oauth/authorize

Initiate the OAuth 2.0 authorization code flow

POST

/api/oauth/token

Exchange an authorization code for an access token

GET

/api/zapier/test

Verify that an access token is still valid

GET

/api/zapier/campaigns

List configured review campaigns

POST

/api/zapier/review-request

Send a review-request email to a named customer

GET

/api/oauth/authorize

Initiate the OAuth 2.0 authorization code flow

POST

/api/oauth/token

Exchange an authorization code for an access token

GET

/api/zapier/test

Verify that an access token is still valid

GET

/api/zapier/campaigns

List configured review campaigns

POST

/api/zapier/review-request

Send a review-request email to a named customer

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

FiveStars OAuth Bearer tokens are stored encrypted in the Jentic vault. The agent never sees the raw token; Jentic injects it on each call to /api/zapier/review-request and the other protected endpoints.

Intent-based discovery

Agents search Jentic with intents like 'send a review request' and Jentic returns the FiveStars review-request operation with its input schema, eliminating the need to read the docs.

Time to first call

Direct FiveStars integration: 1-2 days to register an OAuth client and handle the token exchange. Through Jentic: under 1 hour using search, load, execute.

FAQs

Specific to using FiveStars API through Jentic.

Why is there no official OpenAPI spec for FiveStars API?

FiveStars does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call FiveStars API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the FiveStars API use?

The FiveStars API uses OAuth 2.0 with the authorization code grant. Agents redirect users to /api/oauth/authorize, then exchange the returned code for a Bearer access token at /api/oauth/token. Jentic stores the resulting token in its encrypted vault and injects it on each call.

Can I send a review request to a customer with the FiveStars API?

Yes. Call POST /api/zapier/review-request with the customer's email, first name, last name, and the campaignId returned by GET /api/zapier/campaigns. The endpoint sends the review email immediately under that campaign's template.

What are the rate limits for the FiveStars API?

FiveStars does not document a published rate limit for these Zapier endpoints. Treat the API as low-throughput and pace review requests at no more than a few per second per merchant; if you receive a 429 response, back off exponentially before retrying.

How do I trigger a FiveStars review email through Jentic?

Search Jentic for 'send a FiveStars review request', load the schema for POST /api/zapier/review-request, and execute with the customer details. The OAuth token stays in the Jentic vault and is attached at execution time.

FiveStars API

Connect the FiveStars API to your agent

Capabilities

Start building with FiveStars API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs