This is the same API we use in our new Console (/consolev3). You may use it to automate some tasks. It uses HTTP and

Authentication

You can generate a Console API key at Settings → API → Console API. Then, send it as the X-Console-API-Key (case-insensitive) header in each HTTP request to the Console API.

X-Console-API-Key: YOUR_API_KEY

Endpoints

Base URL: https://talk.hyvor.com/api/console/v1/{website_id}

(Replace website_id with your website ID)

All endpoints are organized into “models”. Usually, each models has more or less of a CRUD operation for it. Each endpoint returns an object an array of objects. You can see object definitions belows.

Website

• GET /website - Get website data
• PATCH /website - Update website data

Comments

• GET /comments - Get comments
• PATCH /comment/{id} - Update a comment

More endpoints will be added as we are migrating the front end to /consolev3

Objects