TopTickets API Documentation¶

Welcome to the TopTickets Developer Documentation. The TopTickets API enables you to programmatically manage support tickets, customers, teams, and users within your organization.

Overview¶

The TopTickets API is a RESTful API that uses JSON for request and response bodies. All API access is over HTTPS, and all data is sent and received as JSON.

Base URL:

https://api.toptickets.app/v1

Key Features¶

Ticket Management - Create, update, and track support tickets
Customer Management - Maintain customer records and profiles
Team Collaboration - Organize agents into teams for efficient ticket routing
User Management - Manage agent accounts and permissions
Comments & Attachments - Add notes and files to tickets
Activity Tracking - Full audit trail of all changes

Authentication¶

The API uses Bearer token authentication with API keys. All requests must include an Authorization header:

Authorization: Bearer tt_admin_abc123...

See Authentication for details on obtaining and using API keys.

Quick Links¶

Quickstart

Send your first API request in 5 minutes

Get started
Authentication

Learn about API keys, scopes, and permissions

Authentication guide
Tickets API

Create and manage support tickets

Tickets reference
Customers API

Manage customer records and profiles

Customers reference

API Versioning¶

The API is versioned via the URL path. The current version is v1. We will provide advance notice before releasing breaking changes.

Rate Limits¶

API requests are rate limited based on your API key type:

Key Type	Rate Limit
Admin (`tt_admin_`)	2,000 requests/minute
Read-only (`tt_ro_`)	200 requests/minute
Agent (`tt_agent_`)	200 requests/minute

See Rate Limits for more details.

Need Help?¶

Check the API Reference for endpoint details
Review Error Handling for troubleshooting
See Examples for common use cases