Back to Documentation
API & Developers15 min readUpdated January 2026

REST API Reference

Complete reference for SimplyTicket REST API endpoints. All endpoints use JSON for request and response bodies.

Tickets API

GET/v1/tickets

Retrieve a paginated list of tickets with optional filters.

Query Parameters

statusopen, pending, resolved, closed
prioritylow, medium, high, urgent
assignee_idFilter by assigned agent
pagePage number (default: 1)
per_pageResults per page (default: 25, max: 100)
POST/v1/tickets

Create a new ticket.

# Request body:

{
  "subject": "Need help with billing",
  "description": "I was charged twice",
  "customer_email": "customer@example.com",
  "priority": "medium",
  "tags": ["billing"]
}
GET/v1/tickets/:id

Retrieve a single ticket with full conversation history.

PUT/v1/tickets/:id

Update ticket properties.

{
  "status": "resolved",
  "priority": "low",
  "assignee_id": "usr_abc123"
}

Comments API

POST/v1/tickets/:id/comments

Add a reply or internal note to a ticket.

{
  "body": "Thank you for reaching out...",
  "type": "reply",  // or "internal_note"
  "attachments": []
}

Customers API

GET/v1/customers

List all customers

POST/v1/customers

Create a new customer profile

GET/v1/customers/:id

Get customer with ticket history

PUT/v1/customers/:id

Update customer information

Pagination

All list endpoints return paginated results with metadata:

{
  "data": [...],
  "meta": {
    "total": 1250,
    "page": 2,
    "per_page": 25,
    "total_pages": 50
  }
}