API Reference

You can use our secure REST API to import your customer data, send review requests, export your reviews, and more!

Authentication

Your project has a secret API key that you can use to authenticate your requests. You can find your project’s API key here: https://moregoodreviews.com/settings/developers

Add your API key to the Authorization header of each request. For example:

"Authorization": "Bearer <API_KEY>"

Endpoints

Create or update a customer

POST https://api.moregoodreviews.com/beacon/customers

Creates a new customer or updates an existing one.

Body

NameTypeDescription

first_name*

string

The customer's first name.

last_name

string

The customer's last name.

email

string

The customer's email address.

phone

string

The customer's phone number.

signed_up_at

date

The date the customer signed up to your service.

Create a review request

POST https://api.moregoodreviews.com/beacon/asks

Schedules a review request for the customer.

Body

NameTypeDescription

email

string, required without phone.

The customer's email address

phone

string, required without email.

The customer's phone number

channels

array

Include "email", "sms", or both channels.

reminders_count

integer

0 - 3 reminders.

asked_at

date

The date to schedule the request. If null, it will send immediately.

Create a customer charge

POST https://api.moregoodreviews.com/beacon/charges

Records a charge for the customer.

Body

NameTypeDescription

email

string, required without phone.

The customer's email address.

phone

string, required without email.

The customer's phone number.

amount

integer

Amount of charge in lowest currency denomination.

currency

string

The 3-letter currency code.

charged_at

date

The date the customer was charged.

Get customers

GET https://api.moregoodreviews.com/beacon/customers

Gets all customers for a project.

Get customer reviews

GET https://api.moregoodreviews.com/beacon/customers/:id/reviews

Gets all reviews the customer submitted.

Get customer messages

GET https://api.moregoodreviews.com/beacon/customers/:id/messages

Gets all messages sent to a customer.

Get reviews

GET https://api.moregoodreviews.com/beacon/reviews/

Gets all reviews for a project.

Get messages

GET https://api.moregoodreviews.com/beacon/messages

Get all messages sent for the project.

Pagination

For requests that require pagination, a pagination key is added to the response. This key might look something like the following:

"pagination": {
  "current_page": 2,
  "path": "https://api.moregoodreviews.com/beacon/customers",
  "first_page_url": "https://api.moregoodreviews.com/beacon/customers?page=1",
  "last_page_url": "https://api.moregoodreviews.com/beacon/customers?page=3",
  "prev_page_url": "https://api.moregoodreviews.com/beacon/customers?page=1",
  "next_page_url": "https://api.moregoodreviews.com/beacon/customers?page=3",
  "from": 51,
  "to": 100,
  "total": 110,
  "per_page": 50,
  "last_page": 3
}

Last updated