API Reference

Complete REST API documentation with examples for every endpoint.

Endpoints

GET
/api/tickets

Retrieve all tickets with optional filtering and pagination

List all ticketsFilter by statusPaginate results
Auth required
POST
/api/tickets

Create a new ticket in the system

Submit from emailCreate via APIBulk import
Auth required
GET
/api/tickets/:id

Get a specific ticket by ID

Fetch ticket detailsGet conversation thread
Auth required
PATCH
/api/tickets/:id

Update ticket status, assignment, or metadata

Change statusReassign agentAdd tags
Auth required
GET
/api/agents

List all agents and their current workload

Get team membersCheck availabilityView metrics
Auth required
POST
/api/routing-rules

Create a new routing rule based on conditions

Add skill-based routingCreate priority rule
Auth required
GET
/api/analytics

Retrieve analytics data and performance metrics

Get dashboard dataExport metricsTrend analysis
Auth required
POST
/api/webhooks

Register webhooks for real-time ticket updates

Setup notificationsReal-time syncCustom integrations
Auth required

Authentication

All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from your account settings. Keep it secure and never share it publicly.

Rate Limits

Standard Tier

1,000 requests per hour per API key

Pro Tier

10,000 requests per hour per API key

Enterprise

Custom rate limits based on agreement

Ready to integrate?

Check our SDKs, webhooks, and detailed documentation.