NOTHINGPHISHY
GET/partner-api/inspection-associations

Query inspection associations

Explore the query inspection associations 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 source inspection type.

q.where.brandIdnumber[]

Filter by source inspection brand IDs.

q.where.inspectionUrlobject

Match the source inspection URL.

q.where.associationStatusstring

Filter by associated or unassociated; typically associated.

q.paginationobject

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

EXAMPLE BEFORE ENCODING
{
  "where": {
    "brandId": [
      1
    ],
    "associationStatus": "associated"
  },
  "pagination": {
    "current": 1,
    "pageSize": 10
  }
}

Encode this JSON with encodeURIComponent(JSON.stringify(q)) before sending it as the q parameter.

Responses

Successful responses
200OK
responsepartnerInspectionAssociationResponseoptional
datapartnerInspectionAssociationItem[]optional
sourceInspectionIdintegeroptional
sourceRecordIdstringoptional
sourceUrlstringnulloptional
relationshipTypestringoptional
relatedInspectionIdintegeroptional
relatedRecordIdstringoptional
relatedUrlstringnulloptional
relatedAttackTypestringnulloptional
relatedStatusstringnulloptional
relatedBrandpartnerBrandNameoptional

Related brand. Null when the related inspection has no brand.

brandIdintegeroptional
originalNamestringoptional

Brand name in its original language.

englishNamestringoptional
notestringnulloptional
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