Skip to main content

API Overview

The Convotic API provides programmatic access to your conversations, contacts, and blocks across all connected messaging platforms. All endpoints are available under the /v1 namespace.

Base URL​

https://api.convotic.com/v1

Authentication​

All API requests require an API key passed via the X-API-Key header. You can generate API keys from your Convotic dashboard under Settings > API Keys.

X-API-Key: your-api-key-here
caution

Keep your API key secret. Do not expose it in client-side code or public repositories.

Rate Limits​

API requests are limited to 1,000 requests per minute per API key. Rate limit status is returned in response headers. See Rate Limits for details.

Quick Start​

curl​

curl -X GET "https://api.convotic.com/v1/info" \
  -H "X-API-Key: your-api-key-here"

TypeScript​

const response = await fetch("https://api.convotic.com/v1/info", {
  headers: {
    "X-API-Key": "your-api-key-here",
  },
});

const data = await response.json();
console.log(data);

Response Format​

All successful responses return JSON with endpoint-specific data at the top level:

{
  "version": "1.0.0",
  "blocks": ["inbox", "crm", "broadcast"],
  "docsUrl": "https://docs.convotic.com"
}

All error responses follow a consistent format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable description of the error"
  }
}

See Error Handling for the full list of error codes.

Versioning​

The API is versioned via the URL path (e.g., /v1/). The current version is v1. When breaking changes are introduced, a new version will be released under a new path (e.g., /v2/). Previous versions will remain available during a deprecation period.

See Versioning for the full versioning and deprecation policy.