Platform Info

Retrieve general information about the Convotic API, including the current version, available blocks, and a link to the documentation.

Endpoint

GET /v1/info

Authentication

Requires a valid API key via the X-API-Key header.

Parameters

This endpoint takes no parameters.

Request Example

curl

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

Response Example

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

Response Fields

Field	Type	Description
version	string	The current API version.
blocks	string[]	List of available blocks on your account.
docsUrl	string	URL to the Convotic documentation site.

TypeScript Example

interface InfoResponse {
  version: string;
  blocks: string[];
  docsUrl: string;
}

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

const info: InfoResponse = await response.json();
console.log(`API version: ${info.version}`);
console.log(`Available blocks: ${info.blocks.join(", ")}`);