API Reference
You can use our secure REST API to import your customer data, send review requests, export your reviews, and more!
Last updated
You can use our secure REST API to import your customer data, send review requests, export your reviews, and more!
Last updated
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:
POST https://api.moregoodreviews.com/beacon/customers
Creates a new customer or updates an existing one.
| Name | Type | Description |
|---|---|---|
POST https://api.moregoodreviews.com/beacon/asks
Schedules a review request for the customer.
Body
POST https://api.moregoodreviews.com/beacon/charges
Records a charge for the customer.
GET https://api.moregoodreviews.com/beacon/customers
Gets all customers for a project.
GET https://api.moregoodreviews.com/beacon/customers/:id/reviews
Gets all reviews the customer submitted.
GET https://api.moregoodreviews.com/beacon/customers/:id/messages
Gets all messages sent to a customer.
GET https://api.moregoodreviews.com/beacon/reviews/
Gets all reviews for a project.
GET https://api.moregoodreviews.com/beacon/messages
Get all messages sent for the project.
For requests that require pagination, a pagination key is added to the response. This key might look something like the following:
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
first_name*
string
The customer's first name.
last_name
string
The customer's last name.
string
The customer's email address.
phone
string
The customer's phone number.
location_slug
string
The slug of a location.
signed_up_at
date
The date the customer signed up to your service.
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.
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.