Introduction

API Overview

Overview of the Synoveo REST API

The Synoveo API is organized around REST principles.

Request Format

Headers

Authorization: Bearer <token>
Content-Type: application/json
X-Idempotency-Key: <unique-key>  // For POST/PATCH

Base URL

https://api.synoveo.com/api/v1

Response Format

Success Response

{
  "status": "ok",
  "data": {
    // Response data
  }
}

Error Response

{
  "status": "error",
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable message",
    "details": "Additional context"
  }
}

HTTP Methods

MethodUsage
GETRetrieve resources
POSTCreate resources
PATCHUpdate resources
DELETERemove resources

Authentication

The API supports two authentication methods:

JWT Tokens

For user sessions (dashboard, web apps).

API Keys

For server-to-server communication (WordPress plugin, custom integrations).

Authentication Details

Rate Limiting

Requests are rate limited per plan:

PlanRequests/Hour
Lite100
Solo500
Pro2000
Business10000

Rate Limits

On this page