Raw schema
{
"type": "object",
"properties": {
"ids": {
"description": "Only these ticket ids.",
"type": "array",
"items": {
"type": "string"
}
},
"inbox_ids": {
"description": "Only tickets in these inbox ids.",
"type": "array",
"items": {
"type": "string"
}
},
"states": {
"description": "Only tickets in these states.",
"type": "array",
"items": {
"type": "string",
"enum": [
"open",
"hold",
"closed"
]
}
},
"user_ids": {
"description": "Only tickets assigned to these user ids (\"null\" = unassigned).",
"type": "array",
"items": {
"type": "string"
}
},
"label_ids": {
"description": "Only tickets with these label ids.",
"type": "array",
"items": {
"type": "string"
}
},
"types": {
"description": "Ticket types, e.g. email, chat, sms, phone, web, twitter, whatsapp.",
"type": "array",
"items": {
"type": "string"
}
},
"spam": {
"description": "Only spam (true) or only non-spam (false) tickets.",
"type": "boolean"
},
"trash": {
"description": "Only trashed (true) or only non-trashed (false) tickets.",
"type": "boolean"
},
"since_created_at": {
"description": "Only tickets created since this UTC ISO 8601 time, e.g. 2026-01-31T13:41:10Z.",
"type": "string"
},
"since_updated_at": {
"description": "Only tickets updated since this UTC ISO 8601 time.",
"type": "string"
},
"sort": {
"description": "Sort order; a leading - means descending.",
"type": "string",
"enum": [
"updated_at",
"-updated_at",
"created_at",
"-created_at",
"user_id",
"user_id,-updated_at"
]
},
"per_page": {
"description": "Results per page (0-100, default 10). Use 0 with count to get only the total.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"page": {
"description": "Page number (1-based). Past 10,000 results, filter by since_created_at instead.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"count": {
"description": "If true, also return the total number of matching results (costs 1 extra rate-limit credit).",
"type": "boolean"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}