Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

The Tickets API provides a read interface over the ticket layer that sits beneath incidents, changes, and problems. Rather than querying each domain endpoint separately, use /tickets to get a unified view of everything active in your workspace. The /history endpoint exposes the complete audit log — every status change, reassignment, comment, and system event — making it straightforward to satisfy compliance requirements or prepare for a post-incident review.
All endpoints require Authorization: Bearer <token>.
Base path: https://your-api-domain.com/api/v1/tickets

​
List all tickets

Returns a paginated list of all tickets in the workspace. Each record identifies its originating domain — incident, change, or problem — alongside the current status and assignee. GET /
​
page
number
default:"1"
Page number.
​
limit
number
default:"20"
Items per page (max 100).
​
type
string
Filter by ticket type: INCIDENT, CHANGE, or PROBLEM.
​
status
string
Filter by current lifecycle status.
GET /api/v1/tickets?type=INCIDENT&status=OPEN
Authorization: Bearer <token>
Response 
{
  "success": true,
  "message": "Tickets retrieved",
  "data": [
    {
      "id": "INC-20260522-0041",
      "type": "INCIDENT",
      "summary": "Payment service down",
      "priority": "CRITICAL",
      "status": "OPEN",
      "assignedTo": "oncall@example.com",
      "createdAt": "2026-05-22T14:33:00Z",
      "updatedAt": "2026-05-22T14:45:00Z"
    }
  ],
  "meta": {
    "total": 84,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}
​
id
string
Unique ticket identifier.
​
type
string
Ticket domain: INCIDENT, CHANGE, or PROBLEM.
​
summary
string
Short description of the ticket.
​
priority
string
Severity: LOW, MEDIUM, HIGH, or CRITICAL.
​
status
string
Current lifecycle status.
​
assignedTo
string
Email of the assigned engineer.
​
createdAt
string
ISO 8601 creation timestamp.
​
updatedAt
string
ISO 8601 timestamp of the most recent update.

​
Get ticket history

Returns the complete audit log for tickets in the workspace — every status change, comment, reassignment, priority update, and system-generated event — ordered chronologically. Scope the results to a single ticket using the ticketId query parameter. GET /history
​
ticketId
string
Scope the history to a single ticket ID.
​
from
string
Start of the date range (ISO 8601).
​
to
string
End of the date range (ISO 8601).
​
page
number
default:"1"
Page number.
​
limit
number
default:"20"
Items per page (max 100).
GET /api/v1/tickets/history?ticketId=INC-20260522-0041
Authorization: Bearer <token>
Response 
{
  "success": true,
  "message": "History retrieved",
  "data": [
    {
      "ticketId": "INC-20260522-0041",
      "event": "STATUS_CHANGE",
      "from": "OPEN",
      "to": "ACKNOWLEDGED",
      "actor": "oncall@example.com",
      "timestamp": "2026-05-22T14:38:00Z"
    },
    {
      "ticketId": "INC-20260522-0041",
      "event": "COMMENT_ADDED",
      "actor": "sre@example.com",
      "message": "Identified crash-loop in stripe-service pod",
      "timestamp": "2026-05-22T14:40:00Z"
    }
  ],
  "meta": {
    "total": 12,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}
​
ticketId
string
The ticket this event belongs to.
​
event
string
Event type. Common values: STATUS_CHANGE, COMMENT_ADDED, ASSIGNED, PRIORITY_CHANGE, RESOLVED.
​
from
string
Previous value, present on change events.
​
to
string
New value, present on change events.
​
actor
string
Email of the user or system that triggered the event.
​
message
string
Event detail text, present on comment and note events.
​
timestamp
string
ISO 8601 timestamp of the event.