TidySupport API Reference

This reference provides detailed information about the TidySupport public API endpoints. Use these endpoints to integrate TidySupport features into your own applications.

Getting Started

Our API is organized around REST principles. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Base URL: https://api.tidysupport.com

Authentication

Authentication to the API is performed via API keys. You can view and manage your API keys in your TidySupport dashboard.

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Payload Structure

All API requests use JSON-encoded bodies. Each endpoint has its own specific payload structure as documented in each section.

{
  "to": "user@example.com",
  "subject": "Hello",
  "html": "<p>Your message here</p>"
}

API Endpoints

Explore our API endpoints by category:

Contacts

Create and manage customer contacts in your support inbox

View Contacts API

Conversations

List, filter, and manage support conversations and their status

View Conversations API

Messages

Send and retrieve messages within support conversation threads

View Messages API

Knowledge Base

Manage knowledge base articles that power your AI support agent

View Knowledge Base API

Widget

Install and configure the live chat widget on your website

View Widget Guide

Customers

Sync your user base with TidySupport and manage customers by external ID

View Customers API

Analytics

Query conversation volume, customer counts, and geographic visitor data

View Analytics API

Emails

Send transactional emails based on user actions with raw HTML, templates, or React components

View Emails API

Events

Track user events and behaviors to trigger workflows and segment users

View Events API

API Keys

Manage API keys for authentication and test connections for integrations

View API Keys Reference

Webhooks

Configure webhooks for real-time notifications and automation triggers

View Webhooks API

Users

Manage user data and profiles

View Users API