Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Prisma Reviews Platforms API
version: 1.0.0
summary: One REST API to read and reply to reviews on the App Store, Google Play, Yelp, Tripadvisor and more.
description: 'Read the reviews of the businesses and apps you own or manage on the App Store, Google Play, Judge.me, eBay, Trusted Shops, eKomi, Yelp, Tripadvisor, Booking.com, G2 and 50+ more platforms, all in one normalized JSON shape, and reply through each platform''s official API where it has one (read-only platforms return the link where a review is answered). Google Business Profile, Trustpilot, Allegro, Etsy, Angi and Mercado Libre are coming soon: `GET /v1/platforms` says which platforms are ready (`live_ready`).
- **Auth:** `Authorization: Bearer `. Live keys (`pk_live_…`) work with real accounts; test keys (`pk_test_…`) connect any platform with sample locations and reviews and never publish replies. Test and live data never mix.
- **Format:** JSON in and out; timestamps are ISO 8601 in UTC; IDs are prefixed (`rev_`, `loc_`, `con_`, `we_`, `evt_`, `req_`).
- **Pagination:** `GET /v1/reviews` is cursor paginated (`data` + `next_cursor`).
- **Rate limits:** per key and per minute, set by the plan (Spark 60, Beam 120, Spectrum 600, Aurora 1,200), reported in `X-RateLimit-Limit` and `X-RateLimit-Remaining`.
- **Errors:** one shape, `{ "error": { "type", "code", "message", "retryable", "request_id", "docs_url" } }`; codes on https://prismareviews.com/docs/errors.
- **Webhooks:** signed `POST`s for new and updated reviews, published or failed replies and connection changes.
Get a free API key at https://app.prismareviews.com/signup.'
termsOfService: https://prismareviews.com/terms
contact:
name: Prisma Reviews
url: https://prismareviews.com
email: hello@prismareviews.com
x-logo:
url: https://prismareviews.com/favicon.svg
altText: Prisma Reviews
servers:
- url: https://api.prismareviews.com
description: Production (live and test keys)
security:
- apiKey: []
tags:
- name: Platforms
description: How each platform connects, the fields it needs and whether your workspace can connect it.
externalDocs:
description: Docs
url: https://prismareviews.com/docs/api-reference/platforms
paths:
/v1/platforms:
get:
operationId: listPlatforms
tags:
- Platforms
summary: List platforms
description: Every platform with how it connects, the exact fields `POST /v1/connections` expects, setup steps for the account owner, an example body and whether this workspace can connect it now. Enough to connect a platform without reading the docs.
responses:
'200':
description: All platforms.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformList'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
'503':
$ref: '#/components/responses/Maintenance'
externalDocs:
description: Docs
url: https://prismareviews.com/docs/api-reference/connections#discover-what-each-platform-needs
/v1/platforms/{id}:
get:
operationId: getPlatform
tags:
- Platforms
summary: Get a platform
description: One platform of `GET /v1/platforms`.
parameters:
- name: id
in: path
required: true
description: Platform ID.
schema:
$ref: '#/components/schemas/PlatformId'
example: app_store
responses:
'200':
description: The platform.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
content:
application/json:
schema:
$ref: '#/components/schemas/Platform'
example:
id: app_store
name: App Store
connect: credentials
reply: api
in_your_plan: true
available: true
live_ready: true
live_note: null
summary: An App Store Connect API key with the Customer Support role. Prisma never sees your Apple ID.
steps:
- In App Store Connect open Users and Access → Integrations → App Store Connect API.
console_url: https://appstoreconnect.apple.com/access/integrations/api
fields:
- name: issuer_id
label: Issuer ID
type: text
required: true
placeholder: 57246542-96fe-1a63-e053-0824d011072a
help: The UUID above the list of keys.
example:
platform: app_store
credentials:
issuer_id: …
key_id: …
private_key: …
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: No platform with that ID.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
resource_not_found:
value:
error:
type: not_found_error
code: resource_not_found
message: 'No platform with that id. Use one of: google, app_store, google_play, judge_me, trustpilot, google_maps, yelp, tripadvisor, booking, yotpo, reviews_io, g2, ebay, etsy, steam, okendo, feefo, trusted_shops, ekomi, loox, proven_expert, shopper_approved, wordpress, appexchange, facebook, opentable, doordash, angi, checkatrade, avvo, capterra, apartments, gartner, healthgrades, vitals, classpass.'
retryable: false
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#resource_not_found
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
'503':
$ref: '#/components/responses/Maintenance'
externalDocs:
description: Docs
url: https://prismareviews.com/docs/api-reference/connections#discover-what-each-platform-needs
components:
responses:
InternalError:
description: Something failed on Prisma's side. Retryable.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_error:
value:
error:
type: api_error
code: internal_error
message: Something went wrong on our side. It has been logged; try again.
retryable: true
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#internal_error
RateLimited:
description: More requests this minute than the plan allows for this key. Not counted in usage.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
Retry-After:
$ref: '#/components/headers/Retry-After'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
rate_limited:
value:
error:
type: rate_limit_error
code: rate_limited
message: Rate limit of 60 requests per minute exceeded. Retry in 12 s. Requests over the limit are never billed.
retryable: true
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#rate_limited
Unauthorized:
description: No API key or one not shaped like a Prisma key (`missing_api_key`), or a key that doesn't exist or was revoked (`invalid_api_key`).
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
missing_api_key:
value:
error:
type: authentication_error
code: missing_api_key
message: 'Send your API key as "Authorization: Bearer pk_live_…".'
retryable: false
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#missing_api_key
invalid_api_key:
value:
error:
type: authentication_error
code: invalid_api_key
message: This API key does not exist or was revoked.
retryable: false
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#invalid_api_key
Forbidden:
description: The account is suspended.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
account_suspended:
value:
error:
type: permission_error
code: account_suspended
message: This account is suspended. Write to hello@prismareviews.com.
retryable: false
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#account_suspended
Maintenance:
description: Prisma is under maintenance and the API is paused. Retryable.
headers:
Request-Id:
$ref: '#/components/headers/Request-Id'
Retry-After:
$ref: '#/components/headers/Retry-After'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
maintenance:
value:
error:
type: api_error
code: maintenance
message: Prisma is under maintenance. Try again in a few minutes; see https://prismareviews.com/status.
retryable: true
request_id: req_01KJ8T3C5D7E9F1G3H5J7K9M1N
docs_url: https://prismareviews.com/docs/errors#maintenance
headers:
X-RateLimit-Remaining:
description: Requests left in the current one-minute window.
schema:
type: integer
Request-Id:
description: The `req_…` ID of the request. Include it when you contact support.
schema:
type: string
X-RateLimit-Limit:
description: Requests allowed per minute for this key.
schema:
type: integer
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
schemas:
Platform:
type: object
required:
- id
- name
- connect
- reply
- in_your_plan
- available
- live_ready
- live_note
- summary
- steps
- console_url
- fields
- example
description: How a platform connects and whether this workspace can connect it now.
properties:
id:
$ref: '#/components/schemas/PlatformId'
name:
type: string
description: Display name.
connect:
type: string
enum:
- oauth
- credentials
- listing_url
description: How `POST /v1/connections` connects it.
reply:
type: string
enum:
- api
- read
description: '`api`: Prisma publishes replies. `read`: read only.'
in_your_plan:
type: boolean
description: Whether your plan (or its read packs) includes it.
available:
type: boolean
description: Whether it is enabled for your account (some platforms open gradually).
live_ready:
type: boolean
description: '`false` while it can only be tried with test keys; a live `POST /v1/connections` returns `501 platform_not_available`.'
live_note:
type:
- string
- 'null'
description: Why it isn't ready for live keys yet.
summary:
type: string
description: What the account owner needs before starting.
steps:
type: array
items:
type: string
description: Short setup steps for the account owner.
console_url:
type:
- string
- 'null'
format: uri
description: Where the values come from.
fields:
type: array
items:
$ref: '#/components/schemas/ConnectField'
description: What `POST /v1/connections` expects.
example:
type: object
additionalProperties: true
description: A request body for `POST /v1/connections` that works with a test key.
Error:
type: object
required:
- error
description: Every error has this shape. Some codes add fields (for example `platform`, `url`, `max_length`, `connection_id`, `upgrade_url`, `required_fields`).
properties:
error:
type: object
required:
- type
- code
- message
- retryable
- request_id
- docs_url
additionalProperties: true
properties:
type:
type: string
enum:
- authentication_error
- permission_error
- not_found_error
- conflict_error
- invalid_request_error
- rate_limit_error
- api_error
description: Family of the error, from the HTTP status.
code:
type: string
description: Stable, machine-readable code. Branch on this, not on `message`.
message:
type: string
description: Human-readable explanation. It can change.
retryable:
type: boolean
description: '`true` for 429 and 5xx: the same request can succeed later.'
request_id:
type: string
description: The `req_…` ID, also in the `Request-Id` header.
docs_url:
type: string
description: Description of this code.
format: uri
PlatformId:
type: string
enum:
- google
- app_store
- google_play
- judge_me
- trustpilot
- google_maps
- yelp
- tripadvisor
- booking
- yotpo
- reviews_io
- g2
- ebay
- etsy
- steam
- okendo
- feefo
- trusted_shops
- ekomi
- loox
- proven_expert
- shopper_approved
- wordpress
- appexchange
- facebook
- opentable
- doordash
- angi
- checkatrade
- avvo
- capterra
- apartments
- gartner
- healthgrades
- vitals
- classpass
description: 'Platform ID.
| ID | Platform | Connects with | Replies |
| --- | --- | --- | --- |
| `google` | Google Business Profile | oauth | by API |
| `app_store` | App Store | credentials | by API |
| `google_play` | Google Play | credentials | by API |
| `judge_me` | Judge.me | credentials | by API |
| `trustpilot` | Trustpilot | oauth | by API |
| `google_maps` | Google Maps | listing_url | read only |
| `yelp` | Yelp | listing_url | read only |
| `tripadvisor` | Tripadvisor | listing_url | read only |
| `booking` | Booking.com | listing_url | read only |
| `yotpo` | Yotpo | credentials | read only |
| `reviews_io` | REVIEWS.io | credentials | read only |
| `g2` | G2 | credentials | read only |
| `ebay` | eBay | oauth | by API |
| `etsy` | Etsy | listing_url | read only |
| `steam` | Steam | listing_url | read only |
| `okendo` | Okendo | credentials | read only |
| `feefo` | Feefo | credentials | read only |
| `trusted_shops` | Trusted Shops | credentials | by API |
| `ekomi` | eKomi | credentials | by API |
| `loox` | Loox | credentials | read only |
| `proven_expert` | ProvenExpert | credentials | read only |
| `shopper_approved` | Shopper Approved | credentials | read only |
| `wordpress` | WordPress.org | listing_url | read only |
| `appexchange` | Salesforce AppExchange | listing_url | read only |
| `facebook` | Facebook | listing_url | read only |
| `opentable` | OpenTable | listing_url | read only |
| `doordash` | DoorDash | listing_url | read only |
| `angi` | Angi | listing_url | read only |
| `checkatrade` | Checkatrade | listing_url | read only |
| `avvo` | Avvo | listing_url | read only |
| `capterra` | Capterra | listing_url | read only |
| `apartments` | Apartments.com | listing_url | read only |
| `gartner` | Gartner Peer Insights | listing_url | read only |
| `healthgrades` | Healthgrades | listing_url | read only |
| `vitals` | Vitals | listing_url | read only |
| `classpass` | ClassPass | listing_url | read only |'
PlatformList:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/Platform'
ConnectField:
type: object
required:
- name
- label
- type
- required
properties:
name:
type: string
description: Key inside `credentials`, or `listing_url` at the top level of the request.
label:
type: string
description: Label for a form.
type:
type: string
enum:
- text
- secret
- textarea
- list
- url
required:
type: boolean
placeholder:
type: string
description: Example value.
help:
type: string
description: Where to find the value.
file_accept:
type: string
description: 'For textarea fields: the file the value usually comes from.'
securitySchemes:
apiKey:
type: http
scheme: bearer
bearerFormat: pk_live_… / pk_test_…
description: 'Your secret API key as a Bearer token: `pk_live_…` for real accounts, `pk_test_…` for sample data. Keep it on your server.'
externalDocs:
description: Prisma Reviews API reference
url: https://prismareviews.com/docs/api-reference