API Overview

Programmatic access to Conduits for triggering syncs, reading digests, and managing contacts.

Overview

Conduits exposes a REST API for programmatic access to your sync pipeline, digests, and contact matching. All endpoints require authentication.

Authentication

All API requests must include a valid session cookie (the same cookie set when you log into the dashboard). If you're building integrations, use the session from your authenticated browser or call the auth endpoints programmatically.

For server-to-server access, use the admin API key:

GET /api/admin/status?key=YOUR_ADMIN_API_KEY

Base URL

https://your-conduit-instance.com/api

For local development:

http://localhost:3000/api

Response Format

All endpoints return JSON. Successful responses include the requested data. Error responses follow this format:

{
  "error": "Human-readable error message"
}

HTTP status codes:

200 — Success
400 — Bad request (missing or invalid parameters)
401 — Unauthorized (not logged in)
404 — Resource not found
429 — Rate limited
500 — Internal server error

Rate Limits

API requests are not explicitly rate-limited on the Conduits side, but the underlying Telegram and HubSpot APIs have their own limits. Conduits respects these automatically during syncs (token bucket at 20 req/sec for Telegram, automatic retry with backoff for HubSpot).

Available Endpoints

Authentication — Sign in and session management
Endpoints — Sync triggers, digests, contacts, settings
Webhooks — HubSpot and Stripe webhook handlers