Raw schema
{
"type": "object",
"properties": {
"archived": {
"description": "true = only archived tickets, false = no archived tickets (default), any = both.",
"type": "string",
"enum": [
"true",
"false",
"any"
]
},
"spam": {
"description": "Include tickets marked as spam (default false).",
"type": "boolean"
},
"trash": {
"description": "Include trashed tickets (default false).",
"type": "boolean"
},
"has_replies": {
"description": "true = only tickets that have replies, false = only tickets without replies.",
"type": "boolean"
},
"max_replies": {
"description": "Only tickets with this number of replies (not with has_replies=false).",
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"assigned_user": {
"description": "me = assigned to the token's user, an agent id (from supportbee_list_users), any = assigned to someone, none = unassigned.",
"type": "string",
"pattern": "^(me|any|none|\\d{1,12})$"
},
"assigned_team": {
"description": "mine = assigned to the user's teams, a team id (from supportbee_list_teams), none = no team.",
"type": "string",
"pattern": "^(mine|none|\\d{1,12})$"
},
"label": {
"description": "Only tickets with this label name (supportbee_list_labels).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"since": {
"type": "string",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?|\\d{9,11})$",
"description": "Only tickets with last activity after this time (date, ISO date-time or Unix timestamp)."
},
"until": {
"type": "string",
"pattern": "^(\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?|\\d{9,11})$",
"description": "Only tickets with last activity before this time (date, ISO date-time or Unix timestamp)."
},
"sort_by": {
"description": "Sort order (default last_activity).",
"type": "string",
"enum": [
"last_activity",
"creation_time"
]
},
"requester_emails": {
"description": "Only tickets from these requester e-mail addresses (max 10).",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"total_only": {
"description": "Return only the total number of matching tickets.",
"type": "boolean"
},
"per_page": {
"description": "Tickets per page, 1-99 (default 15).",
"type": "integer",
"minimum": 1,
"maximum": 99
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}