latestOpenAPI 3.0.02026-08-19306332608.3 KB
b8a72fda881e
Ticket
Get all tickets
Get all tickets in a project with support for filtering, sorting, and pagination.
Filtering:
- Filter by type: type=BUG or type=BUG,FEATURE_REQUEST
- Filter by status: status=OPEN
- Filter by priority: priority=HIGH or priority=HIGH,MEDIUM
- Filter by archived state: archived tickets are hidden by default; pass ignoreArchived=true to include them, or ignoreArchived=true&archived=true for archived tickets only
- Filter by spam: isSpam=false
- Filter the archive by archive date: startDate / endDate (ISO 8601) narrow the archive, spam and waiting-on-customer views to tickets archived within that range. Ignored on the non-archive views, where archivedAt is unset.
Sorting:
- Sort by creation date: sort=-createdAt (newest first) or sort=createdAt (oldest first)
- Sort by priority: sort=priority (highest first: HIGH, MEDIUM, LOW) or sort=-priority (lowest first)
- Sort by updated date: sort=-updatedAt
- Default sort (no sort param): most recent activity first (lastNotification descending)
- Archived, spam and waiting-on-customer views always sort by archivedAt descending; a sort param is ignored there
Pagination:
- Limit results: limit=20 (default: 500, max: 500)
- Skip results: skip=0 (for pagination: skip=(page-1)*limit)
Retention — read this before building an export:
- type=BOT conversations (AI conversations that never reached a human) are closed and archived about 3 days after they are created, and permanently deleted 30 days after that. Roughly the last 33 days are available; older AI-only conversations no longer exist and cannot be exported or restored.
- Every other ticket type is permanently deleted 365 days after it was archived, or after the project's custom archive window if one is configured. Unarchived tickets are never deleted by retention.
- A conversation handed over to a human stops being type=BOT (it becomes INQUIRY or the type the handover assigns) and from then on follows the longer window above.
- Ticket history entries have their own 180-day window — see GET /tickets/{ticketId}/history.
get/tickets
Headers
projectstring required
Response
Ok
{"stackTrail":"paths:/tickets:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}