/partner-api/ticketsQuery tickets
Explore the query tickets endpoint, including request parameters and response details.
Parameters
1 parameterqstringoptionalJSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.
q.where.typestring[]Filter by risk type.
q.where.brandIdnumber[]Filter by accessible brand IDs.
q.where.createdAtobjectFilter by creation time using ISO 8601 values.
q.where.statusIdnumber[]Ticket status: 2 Open, 3 Pending, 4 Resolved, 5 Closed.
q.where.workOrderIdstringFilter by ticket ID.
q.where.incidentUrlobjectMatch the incident URL, including fuzzy matching.
q.paginationobjectPagination: current page and pageSize; defaults are 1 and 20.
{
"where": {
"brandId": [
1
],
"statusId": [
2
]
},
"pagination": {
"current": 1,
"pageSize": 10
}
}Encode this JSON with encodeURIComponent(JSON.stringify(q)) before sending it as the q parameter.
Responses
Successful responsesresponsepartnerTicketResponseoptionaldatapartnerTicketAudit[]optionalcreatedAtstringoptionalCreated date
createdBystringoptionalCreated by user Id
updatedAtstringoptionalLast updated date
updatedBystringoptionalLast updated by user Id
workOrderIdintegeroptionalfreshdeskIdintegernulloptionalexternalSystemstringnulloptionalexternalIdstringnulloptionalbrandIdintegeroptionalbrandpartnerBrandNameoptionalbrandIdintegeroptionaloriginalNamestringoptionalBrand name in its original language.
englishNamestringoptionaltypestringoptionalsubjectstringoptionaldescriptionstringoptionalrequesterEmailstringoptionalstatusIdintegeroptionalpartnerIdintegeroptionalincidentUrlstringnulloptionaleffectiveUrlstringnulloptionaldomainRegistrarstringnulloptionalispstringnulloptionalasnstringnulloptionalipAddressesstringnulloptionalgeolocationstringnulloptionalnameServerstringnulloptionalsocialPlatformstringintegernulloptionalplatformNamestringnulloptionalsocialAccountstringnulloptionalsocialAccountNamestringnulloptionalfalseReportCompanystringnulloptionalfalseReportUrlstringnulloptionalengineNamestringnulloptionalengineVersionstringnulloptionalappNamestringnulloptionalappPathstringnulloptionalappSHA256stringnulloptionaldetectResultstringnulloptionalfalseReportSourcestringnulloptionalartworkOwnershipstringnulloptionalleakagestringnulloptionalfreshdeskCreatedAtstringoptionalfreshdeskUpdatedAtstringoptionalstatusUpdatedAtstringoptionalreopenedAtstringoptionalresolvedAtstringoptionalclosedAtstringoptionalpendingSincestringoptionalpartnerAttachmentsstring,object[]optionaltagstagInput[]optionalnamestringrequiredtypestringrequiredsubTypestringnulloptionalscopesstring[]optionalvisibilitystringoptionaldescriptionstringnulloptionalpartnerIdintegernulloptionalprocessingTimeintegeroptionalpaginationpaginationoptionaltotalintegeroptionalTotal number of records (unpaginated) based on the query criteria.
pageSizeintegeroptionalPage size. Default page size is applied if not specified. Maximum 100.
currentintegeroptionalCurrent page starting from 1.
