Read-only HTTP API for merchants on the Growth plan to access their reviews and customer Q&A data. Voice review data includes verification status (Verified Human Voice) when available.
Interactive reference: Swagger UI · OpenAPI 3.1 spec (importable into Postman, Insomnia, Bruno, or AI shopping agents that consume OpenAPI).
Generate an API key from the Parlata admin in Shopify (Settings → API access). Pass it as a Bearer token:
curl -H "Authorization: Bearer parlata_xxxxxxxx..." \
https://app.parlata.ai/api/v1/reviewsKeep your key secret. Anyone with it can read your review data. Rotate it from the admin if it leaks.
60 requests per minute per merchant. Exceeding the limit returns 429 Too Many Requests.
List of voice + text reviews for your store.
| Param | Default | Notes |
|---|---|---|
status | approved | One of: pending, approved, published, rejected, all |
kind | — | review or survey to filter by request type |
product_id | — | Shopify product GID or numeric id |
limit | 50 | 1-200 |
cursor | — | Review id from a previous next_cursor |
Each review object: id, kind, product_id, order_id, stars, language, transcript, raw_transcript, audio_url, audio_mime_type, status, approved_at, rejected_at, rejection_reason, merchant_reply, merchant_replied_at, created_at, verification, survey_prompt.
audio_url is a 1-hour signed URL. Re-fetch to refresh.
verification is an object: { status, score, verified_at }. Status is one of PROCESSING, VERIFIED, FLAGGED, FAILED, NOT_APPLICABLE. Use it to render a "Verified Human Voice" badge in your custom storefront.
Public customer Q&A for your products (visitor questions + your answers).
| Param | Default | Notes |
|---|---|---|
status | answered | pending, answered, rejected, all |
product_id | — | Filter to one product |
limit | 50 | 1-200 |
| Code | Meaning |
|---|---|
| 401 | Missing, malformed, or invalid API key |
| 403 | Plan does not include API access (upgrade to Growth) |
| 429 | Rate limit exceeded |
| 5xx | Server error — retry with backoff |
curl -H "Authorization: Bearer parlata_..." \
"https://app.parlata.ai/api/v1/reviews?limit=10"curl -H "Authorization: Bearer parlata_..." \
"https://app.parlata.ai/api/v1/reviews?kind=survey&product_id=1234567890"curl -H "Authorization: Bearer parlata_..." \
"https://app.parlata.ai/api/v1/qa?status=pending"Need write endpoints (e.g. import reviews from another platform)? Get in touch at onboarding@parlata.ai.