canonical: https://jentic.com/apis/yotpo.com/yotpo-ugc-api

# Yotpo UGC API

Yotpo User Generated Content API for reviews, Q&A, coupons, visual UGC, and email analytics. The API exposes 34 endpoints secured with bearer authentication.

## For AI agents

Programmatically yotpo authentication, create review. Covers 34 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for analytics only.

## Capabilities

- Yotpo authentication
- Create review
- List all reviews
- Get review by ID
- Search reviews

## Use cases

### Analytics Operations

Use the Yotpo UGC API to perform analytics operations programmatically. The API provides 34 endpoints covering core functionality including yotpo authentication, create review, list all reviews.

Example prompt: Call POST /oauth/token to yotpo authentication

### Automated Authentication Management

Automate authentication operations by combining multiple Yotpo UGC API endpoints. Agents can create review and then list all reviews in a single workflow.

Example prompt: Call POST /reviews to create review, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Yotpo UGC API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'yotpo authentication', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /oauth/token | Yotpo authentication |
| POST | /reviews | Create review |
| GET | /reviews | List all reviews |
| GET | /reviews/{review_id} | Get review by ID |
| GET | /products/{product_id}/reviews | Get product reviews |
| GET | /products/{product_id}/bottomline | Get product rating |
| POST | /reviews/search | Search reviews |
| POST | /reviews/{review_id}/vote | Vote on review |

## Key resources

- **Authentication** — Operations related to Authentication
- **Coupons** — Operations related to Coupons
- **Email Analytics** — Operations related to Email Analytics
- **Insights** — Operations related to Insights
- **Privacy** — Operations related to Privacy

## Why Jentic

- **Setup:** Wiring the Yotpo UGC API by hand means running its OAuth token exchange against api.yotpo.com, carrying the bearer token on each call, and handling retries yourself. Through Jentic you install once, import the Yotpo UGC API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The Yotpo UGC API puts the review and product ids in the URL path (/reviews/{review_id}, /products/{product_id}/reviews), so a rule can pin your agent to one review or product: it reads that record and nothing else. You choose the operations it may call, so writes like creating a review or voting are not included unless you add them.
- **Credential handling:** Your Yotpo token 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 'get a product's reviews' or 'search reviews', and Jentic returns the matching Yotpo UGC API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Yotpo UGC API use?

The Yotpo UGC API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I yotpo authentication with the Yotpo UGC API?

Yes. Use the POST /oauth/token endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Yotpo UGC API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I yotpo authentication through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'yotpo authentication'. Jentic returns the matching Yotpo UGC API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Yotpo UGC API have?

The Yotpo UGC API exposes 34 endpoints covering authentication, coupons, email analytics operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which Yotpo UGC API operations and credentials the agent may use. Because the API carries review and product ids in the URL path, such as /reviews/{review_id} and /products/{product_id}/reviews, a rule can pin the agent to a single review or product and let it read that record and nothing else. You choose the operations it may call, so write actions like creating a review through POST /reviews or voting through POST /reviews/{review_id}/vote are excluded unless you add them.