Connections

List your connected systems

Returns

200 The connections, and whether the switch is on. data is ConnectionList.

Errors

invalid_requestunauthorizedforbiddenupgrade_requiredrate_limitedserver_error

Request

curl "https://app.zentiqai.com/v1/connections" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.listConnections();

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.list_connections()

{
  "data": {
    "on": true,
    "connections": [
      {
        "id": "conn_123",
        "kind": "mcp",
        "name": "Zoe",
        "label": "…",
        "status": "pending",
        "statusWords": "…"
      }
    ]
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Connect one of your systems

Body

• kind"mcp" | "calcom" | "hubspot" | "shopify" | "google_calendar" | "microsoft_calendar" | "slack" | "zapier"required

  Which system.

• labelstring | null

  A plain name (never a key).

  at most 60 characters

• urlstring | null

  mcp: the server's public https MCP address (standard port; private and local addresses are refused).

• auth"none" | "bearer" | "oauth" | null

  mcp: how it signs in. oauth: the answer's authorizeUrl is where an owner approves it, signed in to the console.

• tokenstring | null

  mcp (bearer), hubspot (a private app's access token) or shopify (an older app's Admin API access token, made in the Shopify admin before 2026). Write-only: checked, sealed in the vault and never returned (only a masked hint).

• apiKeystring | null

  calcom: a Cal.com API key. Write-only: checked, sealed in the vault and never returned (only a masked hint).

• eventTypeIdstring | number | null

  calcom: the event type's number.

• timeZonestring | null

  calcom, google_calendar, microsoft_calendar: an IANA time zone, like America/New_York.

• shopstring | null

  shopify: the shop's address, like your-shop.myshopify.com.

• clientIdstring | null

  shopify: a Dev Dashboard app's Client ID (the app's Settings), with clientSecret instead of token. Zentiq asks Shopify for the app's 24-hour tokens itself (the client credentials grant: the store must be in the app's own Shopify organisation).

  at most 100 characters

• clientSecretstring | null

  shopify: a Dev Dashboard app's Client secret, with clientId. It also verifies the order notifications Shopify sends for order emails. Write-only: checked, sealed in the vault and never returned (only a masked hint).

• apiSecretstring | null

  shopify with token: the older app's API secret key, which only order emails need (Shopify signs its order notifications with it). Write-only: checked, sealed in the vault and never returned (only a masked hint).

• propertiesstring | string[] | null

  hubspot: the contact properties the avatar may read (HubSpot's own names).

• calendarIdstring | null

  google_calendar: which calendar ("primary" unless named).

• hoursmap of string | null

  google_calendar, microsoft_calendar: opening hours per day, like { "mon": "09:00-17:00" } (a day left out is closed).

• slotMinutesnumber | null
• lengthMinutesnumber | null
• titlestring | null

  google_calendar, microsoft_calendar: a booking's title.

  at most 60 characters

Returns

201 Connected (or waiting for its sign-in). data is ConnectionCreated.

Errors

invalid_requestunauthorizedforbiddenupgrade_requiredconflictrate_limitedserver_error

Request

curl -X POST "https://app.zentiqai.com/v1/connections" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "mcp"
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.createConnection({
  kind: "mcp",
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.create_connection({
    "kind": "mcp",
})

{
  "data": {
    "connection": {
      "id": "conn_123",
      "kind": "mcp",
      "name": "Zoe",
      "label": "…",
      "status": "pending",
      "statusWords": "…"
    },
    "authorizeUrl": "https://www.example.com"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Disconnect a system

Path parameters

• idstringrequired

  Connection id (conn_…).

Returns

200 Disconnected. data is ConnectionDeleted.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundrate_limitedserver_error

Request

curl -X DELETE "https://app.zentiqai.com/v1/connections/conn_123" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.deleteConnection("conn_123");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.delete_connection("conn_123")

{
  "data": {
    "id": "…",
    "actionsOff": 1
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

Test a connection

Path parameters

• idstringrequired

  Connection id (conn_…).

Returns

200 How it went. data is ConnectionTest.

Errors

invalid_requestunauthorizedforbiddenupgrade_requirednot_foundconflictrate_limitedserver_error

Request

curl -X POST "https://app.zentiqai.com/v1/connections/conn_123/test" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.testConnection("conn_123");

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.test_connection("conn_123")

{
  "data": {
    "ok": true,
    "words": "…",
    "connection": {
      "id": "conn_123",
      "kind": "mcp",
      "name": "Zoe",
      "label": "…",
      "status": "pending",
      "statusWords": "…"
    }
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}