Our API provides read-only access to review data for thousands of businesses and is used to power review widgets and reputation management dashboards. Our expectation is that your API integration will make use of your own local storage and/or caching of the data so as not to overburden our resources.
This feature is only available to users with an Agency or Partner plan. We are not able to provide support for API development or implementation beyond this documentation.
In this Article:
A set of functions and procedures allowing the creation of applications that access the features or data of an operating system, application, or other service.
API information may be required in the following scenarios:
- Using the API to pull email addresses from a client's existing CRM to automate email and SMS review request campaigns.
- Add a new client profile from an agency's own proprietary platform to Grade.us using the API
- Customize review performance reporting to clients using review data pulled from the API.
API documentation for Version 2 of the API can be found here.
If you currently utilize Version 1, please note that it is no longer being updated. Documentation for Version 1 can be acquired upon request. Please email firstname.lastname@example.org for more information.
While Grade.us does provide access to our API, we are unable to provide any support for development or implementation for any API customization. This access is best used by customers who have an internal capacity for this level of customization.
API keys are only available to our Agency and Partner plan users. If you would like an API key to use with our review stream plugins and modules, please contact email@example.com.
Granting a unique API token to a client is easy and can be done either when setting up a new client or added to an existing client's user account.
1. Navigate to Manage > Users.
2. When adding or editing a user, simply check the Has API access? box to add a token to their account.
Users will be able to access their API key going to "My Account."
End of Article:
If you have any questions about the API, please feel free to reach out to firstname.lastname@example.org. We are not able to provide support for API development or implementation beyond this documentation.