API Overview

Build integrations and automate workflows with the Relay API.

What You Can Do

Read Data

List tickets and filter by criteria
Get customer information
Retrieve conversations and replies
Access analytics data

Write Data

Create tickets programmatically
Update ticket status, priority, tags
Add replies and internal notes
Create and manage customers

Automate Workflows

Sync with external systems
Build custom integrations
Trigger actions based on events

API Basics

Base URL

https://your-domain.com/api/v1

Request Format

All requests use:

HTTPS only
JSON request/response bodies
UTF-8 encoding

Response Format

{
  "data": { ... },
  "meta": {
    "limit": 50,
    "total": 150,
    "next_cursor": "2026-01-13T00:00:00.000Z"
  }
}

Authentication

API Keys

Generate API keys in Settings → API Keys.

Authorization: Bearer YOUR_API_KEY

Permissions

API keys inherit permissions from the user who created them.

Learn more about Authentication →

Rate Limits

Default Limit

100 requests per minute per API key.

Rate Limit Headers

Responses include:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1610000000

Handling Limits

When rate limited:

Response: 429 Too Many Requests
Wait until reset time
Implement exponential backoff

Endpoints

Core Resources

Resource	Endpoint
Tickets	`/tickets`
Customers	`/customers`
Conversations	`/conversations`
Users	`/users`
Tags	`/tags`

Example Requests

List tickets:

curl -H "Authorization: Bearer API_KEY" \
  https://your-domain.com/api/v1/tickets

Create ticket:

curl -X POST \
  -H "Authorization: Bearer API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject": "Help needed", "customer_email": "user@example.com"}' \
  https://your-domain.com/api/v1/tickets

Full REST API Reference → OpenAPI spec: https://your-domain.com/openapi.json

Webhooks

Get notified when events occur:

Ticket created
Status changed
Conversation added
Customer created

Configure webhooks to send HTTP requests to your server.

Learn more about Webhooks →

SDKs & Libraries

SDKs

No official SDKs are bundled yet. Use the OpenAPI spec to generate a client for your preferred language.

Common Use Cases

CRM Integration

Sync customer data between Relay and your CRM:

Create customers on signup
Update contact information
Link to external records

Ticketing Automation

Automate ticket management:

Create tickets from external forms
Auto-categorize based on content
Route to appropriate teams

Reporting

Build custom reports:

Export ticket data
Aggregate metrics
Feed into BI tools

Custom Workflows

Connect to your systems:

Notify Slack on events
Update project management tools
Trigger internal processes

Testing

Sandbox Environment

Test API without affecting production:

https://staging.your-domain.com/api/v1

Test API Keys

Use a staging workspace with its own API keys for testing.

Support

Developer Resources

API Reference Documentation
Code Examples
Postman Collection

Getting Help

developer@relay.help
Community forum
GitHub issues