Changelog

All notable changes to the g-tateth API will be documented in this file.

​

[1.1.0] - 2026-05-04

​

Documentation (GT-67 — Swagger/OpenAPI refresh)

This release closes the drift between the live API and all machine-readable and human-facing documentation.

• New endpoints documented — all eight GDPR Data Privacy endpoints (/api/data-privacy/*) now appear in the OpenAPI spec and Swagger UI, including request/response schemas for all rights: export, deletion, access, rectification, restriction, and objection
• Health endpoint — GET /api/v1/health (no auth required) is now documented in the spec; useful for uptime monitoring and connectivity checks before authentication
• Analytics tags endpoint — GET /api/v1/analytics/tags is now documented with full parameter and response schemas
• Complete error responses — all v1 endpoints now document 401, 403, 404, 422, and 429 response shapes using $ref to shared response components; NotFoundError and ValidationError response components added
• Schema fixes
  • Conversation.status enum updated to include snoozed
  • Conversation.channel enum now lists all supported channels: email, chat, phone, whatsapp, instagram, twitter, facebook, sms
  • Conversation.labels field added to the schema
  • Customer.tier default corrected to bronze (was incorrectly shown as standard in create docs)
  • Customer schema extended with company, jobTitle, customFields, createdAt, updatedAt
  • Webhook schema extended with headers, retryPolicy, createdAt, updatedAt
  • ApiKey schema extended with ipWhitelist
• New schema components — ValidationError, DataPrivacyRequestSummary, DataRightsRequestBody, DataRightsRequestSummary
• Tags updated — Health and Data Privacy tag groups added; existing tag descriptions clarified (auth requirement and supported auth types)
• Security scheme descriptions updated to include key format examples and token lifetime
• dataPrivacy.ts added to swagger-jsdoc API scan list — the swagger config now picks up JSDoc annotations from src/routes/dataPrivacy.ts
• docs/openapi.json updated to include all of the above changes; version bumped 1.0.0 → 1.1.0

​

Client integration guides updated

• docs/guides/getting-started.md fully rewritten: added Prerequisites section, health-check step, pagination semantics table (parameters + response fields, iteration pattern), complete curl examples for create-customer/create-conversation/register-webhook, error code reference table, rate limit header table, and direct links to Swagger UI (/api-docs/) and the raw spec (/api-docs/spec.json)
• docs/guides/authentication.mdx corrected and extended: fixed the permission table (read:webhooks/write:webhooks were wrong — the API uses webhook:manage); reformatted permissions as a table with descriptions; added Swagger UI and raw spec URL links

​

No breaking changes

All changes are additive (new documented paths, richer schemas, additional error responses). No endpoint contracts, base URLs, or auth mechanisms were changed.

---

​

[1.0.0] - 2025-01-01

​

Added

• API Access Architecture - Complete tenant API access system
  • API key management with production/staging environments
  • Dual authentication (API keys + JWT)
  • Permission-based access control
  • Rate limiting per API key
  • Usage tracking and analytics
• API Endpoints
  • Conversations API (/api/v1/conversations)
  • Customers API (/api/v1/customers)
  • Webhooks API (/api/v1/webhooks)
  • Analytics API (/api/v1/analytics)
  • API Keys Management (/api/tenant/api-keys)
• Webhooks
  • Event subscriptions
  • HMAC signature verification
  • Automatic retry with exponential backoff
  • Delivery logs and status tracking
• SDKs
  • JavaScript/TypeScript SDK
  • Python SDK
  • PHP SDK (coming soon)
• Developer Console
  • UI for managing API keys
  • Usage statistics and analytics
  • Webhook management interface
• Features
  • Automatic API key rotation
  • IP whitelisting
  • Per-key rate limits
  • Usage alerts
  • API monitoring and logging

​

Changed

• Enhanced phone conversation email sending for agent replies
• Improved API usage tracking accuracy
• Updated error handling and response formats

​

Fixed

• TypeScript build errors in frontend API services
• API usage count discrepancies
• Endpoint path tracking in usage analytics

​

[0.9.0] - 2024-12-01

​

Added

• Initial API structure
• Basic authentication
• Core conversation and customer endpoints

---