View customer's campaign list and report

As a Reseller you can list a customer’s phishing, smishing, or quishing campaigns and get reports for a specific campaign or campaign job. Get the customer’s Company ID, then call the campaign search and campaign-job-report endpoints with X-KEEPNET-Company-Id so results are scoped to that company. Use a credential with Client Role = Reseller. The same pattern applies to phishing, smishing, and quishing simulators — only the base path changes.

---

POST /api/companies/search

Get the customer’s Company ID. Use the resourceId of the desired company in the next steps.

Retrieves a paginated list of all companies you manage with license details. Each item includes resourceId — use it as the Company ID for scoped requests. Test it: Authorize with Client ID/Secret, then Send — request body is pre-filled.

Retrieves a list of all companies

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 10

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

isTargetUserCountExceededLimitbooleanOptional

If true, only companies exceeding license limit are returned

Example: false

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/companies/search

HTTPcURLJavaScriptPython

POST /api/companies/search HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 126

{
  "pageNumber": 1,
  "pageSize": 10,
  "orderBy": "CreateTime",
  "ascending": false,
  "filter": {
    "Condition": "AND",
    "SearchInputTextValue": ""
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "limitExceededCompanyCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "companyName": "text",
        "companyResourceId": "text",
        "resellerName": "text",
        "industryName": "text",
        "industryResourceId": "text",
        "licenseTypeName": "text",
        "licenseTypeResourceId": "text",
        "isNumberOfUsersLimited": true,
        "numberOfUsers": "text",
        "privacyDurationId": 1,
        "licenceExpired": true,
        "licenseEndDate": "2026-03-09T16:00:39.027Z",
        "createTime": "2026-03-09T16:00:39.027Z",
        "targetUserCount": 1,
        "children": [
          {
            "companyName": "text",
            "companyResourceId": "text",
            "resellerName": "text",
            "industryName": "text",
            "industryResourceId": "text",
            "licenseTypeName": "text",
            "licenseTypeResourceId": "text",
            "isNumberOfUsersLimited": true,
            "numberOfUsers": "text",
            "privacyDurationId": 1,
            "licenceExpired": true,
            "licenseEndDate": "2026-03-09T16:00:39.027Z",
            "createTime": "2026-03-09T16:00:39.027Z",
            "targetUserCount": 1,
            "children": "[Circular Reference]",
            "tags": [
              "text"
            ],
            "deletedTargetUserCount": 1,
            "inactiveTargetUserCount": 1,
            "monthlyActiveUserCount": 1
          }
        ],
        "tags": [
          "text"
        ],
        "deletedTargetUserCount": 1,
        "inactiveTargetUserCount": 1,
        "monthlyActiveUserCount": 1
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

From the response, pick the company (e.g. by name) and note its resourceId. Example: "resourceId": "xC5kfGz7w2Nz" → use xC5kfGz7w2Nz as Company ID in the campaign and report requests below.

---

POST /api/phishing-simulator/phishing-campaign/search

Send the Company ID in the X-KEEPNET-Company-Id header so the list is scoped to the chosen company. Returns a paginated list of phishing campaigns for that customer. Response includes campaign resourceId, name, status, and other fields.

Returns a list of the phishing campaigns. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>. Request body: optional filter, pageNumber, pageSize, orderBy, ascending. Test it: Endpoints → PhishingCampaign → Returns a list of the phishing campaigns — use dummy data (H8d) and set the header to a Company ID from companies/search. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>. Request body: optional filter, pageNumber, pageSize, orderBy, ascending. Test it: Endpoints → PhishingCampaign → Returns a list of the phishing campaigns — use dummy data (H8d) and set the header to a Company ID from companies/search.

Returns a list of the phishing campaigns

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

orderBystring · nullableOptional

ascendingbooleanOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/phishing-simulator/phishing-campaign/search

HTTPcURLJavaScriptPython

POST /api/phishing-simulator/phishing-campaign/search HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 427

{
  "filter": {
    "searchInputTextValue": "text",
    "condition": "text",
    "filterGroups": [
      {
        "condition": "text",
        "filterItems": [
          {
            "fieldName": "text",
            "operator": "text",
            "value": "text",
            "customFieldName": "text"
          }
        ],
        "filterGroups": [
          {
            "condition": "text",
            "filterItems": [
              {
                "fieldName": "text",
                "operator": "text",
                "value": "text",
                "customFieldName": "text"
              }
            ],
            "filterGroups": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "pageNumber": 1,
  "pageSize": 1,
  "orderBy": "text",
  "ascending": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "resourceId": "text",
        "name": "text",
        "method": "text",
        "methodDetail": "text",
        "scenarioCount": "text",
        "instanceCount": "text",
        "targetUsers": "text",
        "status": "text",
        "instanceGroup": 1,
        "hasTraining": true,
        "jobResultMessage": "text",
        "createdBy": "text",
        "createTime": "2026-03-09T16:00:39.027Z",
        "lastLaunch": "2026-03-09T16:00:39.027Z",
        "emailDelivery": "text",
        "frequency": 1,
        "categoryDistributionType": "text"
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

Example request headers:

Authorization: Bearer <your_access_token>
Content-Type: application/json
X-KEEPNET-Company-Id: xC5kfGz7w2Nz

Example body (dummy data — first page):

{
  "pageNumber": 1,
  "pageSize": 20
}

Smishing and quishing

Same flow with a different base path and same header:

• Smishing: POST /api/smishing-simulator/smishing-campaign/search

• Quishing: POST /api/quishing-simulator/quishing-campaign/search

---

POST /api/phishing-simulator/phishing-campaign-job-report/search

Campaign jobs are run instances of a campaign. To get job-level reports (summary, clicked users, export), use this endpoint — it returns jobs with resourceId and instanceGroup that you need for the summary and export endpoints. Send X-KEEPNET-Company-Id. From the response, note resourceId and instanceGroup for the job you want to report on.

Retrieves campaign job's list. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>. Request body: see Endpoints → PhishingCampaignJobReport for the search request schema.

Retrieves campaign job's list.

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

orderBystring · nullableOptional

ascendingbooleanOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/phishing-simulator/phishing-campaign-job-report/search

HTTPcURLJavaScriptPython

POST /api/phishing-simulator/phishing-campaign-job-report/search HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 427

{
  "filter": {
    "searchInputTextValue": "text",
    "condition": "text",
    "filterGroups": [
      {
        "condition": "text",
        "filterItems": [
          {
            "fieldName": "text",
            "operator": "text",
            "value": "text",
            "customFieldName": "text"
          }
        ],
        "filterGroups": [
          {
            "condition": "text",
            "filterItems": [
              {
                "fieldName": "text",
                "operator": "text",
                "value": "text",
                "customFieldName": "text"
              }
            ],
            "filterGroups": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "pageNumber": 1,
  "pageSize": 1,
  "orderBy": "text",
  "ascending": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "phishingCampaignResourceId": "text",
        "instanceGroup": 1,
        "name": "text",
        "startDate": "2026-03-09T16:00:39.027Z",
        "totalOpenedCount": 1,
        "totalClickedCount": 1,
        "totalSubmittedCount": 1,
        "totalAttachmentOpenedCount": 1,
        "totalNoResponseCount": 1,
        "totalTargetUserCount": 1,
        "emailDeliveredUserCount": 1,
        "method": "text",
        "methodDetail": "text",
        "status": "text",
        "jobResultMessage": "text",
        "createdBy": "text",
        "createdDate": "2026-03-09T16:00:39.027Z",
        "emailDelivery": "text",
        "totalSubmittedMFACount": 1
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

GET /api/phishing-simulator/phishing-campaign-job-report/summary/{resourceId}/{instanceGroup}

Returns the summary report for one campaign job (sent, opened, clicked, etc.). Send X-KEEPNET-Company-Id.

Returns campaign job summary. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Retrieves phishing campaign job's summary details.

get

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Path parameters

resourceIdstringRequired

instanceGroupinteger · int32Required

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

get

/api/phishing-simulator/phishing-campaign-job-report/summary/{resourceId}/{instanceGroup}

HTTPcURLJavaScriptPython

GET /api/phishing-simulator/phishing-campaign-job-report/summary/{resourceId}/{instanceGroup} HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "data": {
    "phishingCampaignResourceId": "text",
    "phishingCampaignName": "text",
    "campaignInfo": {
      "startDate": "2026-03-09T16:00:39.027Z",
      "endDate": "2026-03-09T16:00:39.027Z",
      "scheduledDate": "2026-03-09T16:00:39.027Z",
      "totalTargetUserCount": 1,
      "emailDeliveredUserCount": 1,
      "emailNotDeliveredUserCount": 1,
      "emailDeliveryStartDate": "2026-03-09T16:00:39.027Z",
      "emailDeliveryEndDate": "2026-03-09T16:00:39.027Z",
      "frequency": 1,
      "emailDeliveryDuration": "text",
      "scheduleTypeId": 1,
      "categoryDistributionType": "text",
      "trackingReplyInfo": "text",
      "sendUserPreferredLanguage": 1
    },
    "settings": {
      "excludeFromReports": true,
      "duration": 1,
      "smtpName": "text",
      "directEmailSettingName": "text"
    },
    "targetUsers": {
      "randomlyUsersCount": 1,
      "targetGroupsCount": 1,
      "sendRandomlyUsers": true,
      "sendOnlyActiveUsers": true
    },
    "scenarioStats": {
      "openedEmail": 1,
      "clickedEmail": 1,
      "submittedEmail": 1,
      "attachmentOpenedEmail": 1,
      "reportedEmail": 1,
      "noResponseEmail": 1,
      "notDelivered": 1,
      "failedToSend": 1,
      "mfa": 1
    },
    "scenarios": [
      {
        "scenarioInfo": {
          "name": "text",
          "category": "text",
          "methodTypeId": 1,
          "difficultyTypeId": 1,
          "languageShortCode": "text"
        },
        "trainingInfo": {
          "trainingId": "text",
          "trainingDescription": "text",
          "name": "text",
          "categoryName": "text",
          "companyName": "text",
          "languageList": [
            {
              "languageId": "text",
              "languageShortCode": "text"
            }
          ]
        },
        "enrollmentInfo": {
          "enrollmentId": "text"
        },
        "emailTemplateInfo": {
          "resourceId": "text",
          "name": "text",
          "categoryResourceId": "text",
          "difficultyResourceId": "text",
          "fromName": "text",
          "fromAddress": "text",
          "languageShortCode": "text",
          "phishingFileName": "text",
          "phishingFileType": "text",
          "phishingFileUrl": "text",
          "subject": "text",
          "template": "text"
        },
        "emailTemplateInfos": [
          {
            "resourceId": "text",
            "name": "text",
            "categoryResourceId": "text",
            "difficultyResourceId": "text",
            "fromName": "text",
            "fromAddress": "text",
            "languageShortCode": "text",
            "phishingFileName": "text",
            "phishingFileType": "text",
            "phishingFileUrl": "text",
            "subject": "text",
            "template": "text"
          }
        ],
        "landingPageTemplateInfo": {
          "resourceId": "text",
          "name": "text",
          "methodTypeId": 1,
          "difficultyTypeId": 1,
          "urlTemplate": "text",
          "languageShortCode": "text"
        }
      }
    ],
    "scenariosGeneralInfo": {
      "categories": [
        "text"
      ],
      "methodTypeId": 1,
      "difficultyTypeIds": [
        1
      ],
      "languageShortCodes": [
        "text"
      ]
    },
    "landingPageTemplateInfo": {
      "resourceId": "text",
      "name": "text",
      "methodTypeId": 1,
      "difficultyTypeId": 1,
      "urlTemplate": "text",
      "languageShortCode": "text"
    },
    "trainingInfoForCategory": {
      "trainingId": "text",
      "trainingDescription": "text",
      "name": "text",
      "categoryName": "text",
      "companyName": "text",
      "languageList": [
        {
          "languageId": "text",
          "languageShortCode": "text"
        }
      ]
    },
    "enrollmentInfoForCategory": {
      "enrollmentId": "text"
    },
    "smartGroupInfo": {
      "resourceId": "text",
      "name": "text"
    },
    "campaignDurationExpired": true
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

Example: GET /api/phishing-simulator/phishing-campaign-job-report/summary/pJb2kL9mNq/1 with header X-KEEPNET-Company-Id: xC5kfGz7w2Nz.

Export campaign or job report list

• Export campaign list: POST /api/phishing-simulator/phishing-campaign/search/export — same Company ID header and body shape as search (see Endpoints → PhishingCampaign).

• Export campaign job report list: POST /api/phishing-simulator/phishing-campaign-job-report/search/export — same header, request body per Endpoints → PhishingCampaignJobReport.

Smishing and quishing have equivalent paths under smishing-simulator and quishing-simulator (e.g. .../smishing-campaign/search, .../smishing-campaign-job-report/search, .../summary/{resourceId}/{instanceGroup}, .../search/export).

---

Common errors

• 403 Forbidden — Credential is not Reseller, or the Company ID is not one you manage. Set Client Role = Reseller. Roles and permissions →

• 401 Unauthorized — Missing or invalid token. Request a new token via POST /connect/token.

• 404 Not Found / 400 Bad Request — Invalid Company ID or campaign/job ID. Verify Company ID from POST /api/companies/search and job resourceId/instanceGroup from the campaign-job-report search; ensure you send X-KEEPNET-Company-Id for the customer that owns the campaign.

Related: Scope API requests to a customer →. Endpoint details: see Endpoints → PhishingCampaign, PhishingCampaignJobReport (and equivalent paths under smishing-simulator, quishing-simulator).