Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

REVIEWS.io Invitations API

Queue, list, and edit product and company review invitations.

REVIEWS.io Invitations API is one of 6 APIs that REVIEWS.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invitations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.reviews.io.

5 operations 3 paths 3 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.reviews.io
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

REVIEWS.io Invitations API declares 2 security schemes for authenticating requests. An API key is passed in the header as store (storeKey). An API key is passed in the header as apikey (apiKey). By default, every request must be authenticated.

  • storeKey — Your REVIEWS.io public store key.
  • apiKey — Your REVIEWS.io private API key.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Invitations 5

Queue, list, and edit product and company review invitations.

POST
/invitation
Queue a product (and/or company) review invitation
queueProductInvitation body → 200
POST
/product/invitation
Queue a product review invitation
queueProductInvitationOnly 2 params body → 200
GET
/product/invitation
List product invitations
listProductInvitations 4 params → 200
POST
/merchant/invitation
Queue a company review invitation
queueCompanyInvitation 2 params body → 200
GET
/merchant/invitation
List company invitations
listCompanyInvitations 4 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are InvitationRequest (6 properties), InvitationProduct (4 properties), InvitationResponse (2 properties). Each schema is shown below with its type and property counts.

InvitationProduct
object
4 properties
InvitationRequest
object
6 properties 3 required
InvitationResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reviews-io-invitations-api-openapi.yml Raw ↑

Other APIs REVIEWS.io publishes across the network.

REVIEWS.io Company Reviews API
REVIEWS.io Product Reviews API
REVIEWS.io Questions API
REVIEWS.io Ratings API
REVIEWS.io Webhooks API