NOTHINGPHISHY
GET/partner-api/tickets

Query tickets

Explore the query tickets endpoint, including request parameters and response details.

Parameters

1 parameter
qstringoptional

JSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.

DECODED QUERY FIELDS
q.where.typestring[]

Filter by risk type.

q.where.brandIdnumber[]

Filter by accessible brand IDs.

q.where.createdAtobject

Filter by creation time using ISO 8601 values.

q.where.statusIdnumber[]

Ticket status: 2 Open, 3 Pending, 4 Resolved, 5 Closed.

q.where.workOrderIdstring

Filter by ticket ID.

q.where.incidentUrlobject

Match the incident URL, including fuzzy matching.

q.paginationobject

Pagination: current page and pageSize; defaults are 1 and 20.

EXAMPLE BEFORE ENCODING
{
  "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 responses
200OK
responsepartnerTicketResponseoptional
datapartnerTicketAudit[]optional
createdAtstringoptional

Created date

createdBystringoptional

Created by user Id

updatedAtstringoptional

Last updated date

updatedBystringoptional

Last updated by user Id

workOrderIdintegeroptional
freshdeskIdintegernulloptional
externalSystemstringnulloptional
externalIdstringnulloptional
brandIdintegeroptional
brandpartnerBrandNameoptional
brandIdintegeroptional
originalNamestringoptional

Brand name in its original language.

englishNamestringoptional
typestringoptional
subjectstringoptional
descriptionstringoptional
requesterEmailstringoptional
statusIdintegeroptional
partnerIdintegeroptional
incidentUrlstringnulloptional
effectiveUrlstringnulloptional
domainRegistrarstringnulloptional
ispstringnulloptional
asnstringnulloptional
ipAddressesstringnulloptional
geolocationstringnulloptional
nameServerstringnulloptional
socialPlatformstringintegernulloptional
platformNamestringnulloptional
socialAccountstringnulloptional
socialAccountNamestringnulloptional
falseReportCompanystringnulloptional
falseReportUrlstringnulloptional
engineNamestringnulloptional
engineVersionstringnulloptional
appNamestringnulloptional
appPathstringnulloptional
appSHA256stringnulloptional
detectResultstringnulloptional
falseReportSourcestringnulloptional
artworkOwnershipstringnulloptional
leakagestringnulloptional
freshdeskCreatedAtstringoptional
freshdeskUpdatedAtstringoptional
statusUpdatedAtstringoptional
reopenedAtstringoptional
resolvedAtstringoptional
closedAtstringoptional
pendingSincestringoptional
partnerAttachmentsstring,object[]optional
tagstagInput[]optional
namestringrequired
typestringrequired
subTypestringnulloptional
scopesstring[]optional
visibilitystringoptional
descriptionstringnulloptional
partnerIdintegernulloptional
processingTimeintegeroptional
paginationpaginationoptional
totalintegeroptional

Total number of records (unpaginated) based on the query criteria.

pageSizeintegeroptional

Page size. Default page size is applied if not specified. Maximum 100.

currentintegeroptional

Current page starting from 1.

NOTHINGPHISHY API REFERENCE