API documentation

Introduction

Welcome to the Beliv.io API documentation. Our API allows you to retrieve and submit data to our platform programmatically. With the API, you can:

  • Retrieve your business reviews
  • Post new reviews
  • Manage your business listing

API Endpoints

The Beliv.io API consists of the following endpoints:

Reviews

  • GET /api/v1/businesses/{id}/reviews: Retrieve all reviews for a specific business
  • POST /api/v1/businesses/{id}/reviews: Post a new review for a specific business
  • PATCH /api/v1/reviews/{id}: Update an existing review
  • DELETE /api/v1/reviews/{id}: Delete a review

Users

  • GET /api/v1/users: Retrieve a list of all users
  • GET /api/v1/users/{id}: Retrieve a specific user by ID
  • PATCH /api/v1/users/{id}: Update an existing user
  • DELETE /api/v1/users/{id}: Delete a user

Authentication

To access the API, you will need to obtain an API key. You can request an API key by contacting our customer support team at support@beliv.io.

Rate Limits

To ensure fair usage of the API, we have implemented rate limits. The exact limits may vary depending on your API plan. Please contact our customer support team for more information.

Error Handling

If an error occurs while using the API, an error response will be returned in the following format:

{
"error": "Error message"
}

Contact Us

If you have any questions or feedback about the Beliv.io API, please don’t hesitate to contact our customer support team at support@beliv.io.