Pull survey results for a customer

As a Reseller you can list a customer's survey enrollments, get the summary report, and pull per-user survey results (status, progress, and question-level responses) for analysis or reporting. Use a credential with Client Role = Reseller. Send X-KEEPNET-Company-Id and x-ir-company-id (for enrollment search) so results are scoped to that customer.

---

POST /api/companies/search

Use this to get the customer's Company ID; use the resourceId as X-KEEPNET-Company-Id in the requests below. Retrieves a paginated list of companies you manage. 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-09T13:38:38.081Z",
        "createTime": "2026-03-09T13:38:38.081Z",
        "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-09T13:38:38.081Z",
            "createTime": "2026-03-09T13:38:38.081Z",
            "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"
  ]
}

---

POST /api/enrollments/search

Returns a list of enrollments for the customer. Send X-KEEPNET-Company-Id and x-ir-company-id with the same Company ID. Include enrollmentType: "Survey" in the request body to list only survey enrollments. Use enrollmentId from the response for the summary and users report below.

Returns a list of enrollments

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: 20

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

enrollmentTypestringOptional

Optional: use "Survey" to list only survey enrollments

Example: Survey

Responses

200

OK

application/json

statusstring · nullableOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/enrollments/search

HTTPcURLJavaScriptPython

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

{
  "pageNumber": 1,
  "pageSize": 20,
  "orderBy": "CreateTime",
  "ascending": false,
  "filter": {
    "Condition": "AND",
    "SearchInputTextValue": "",
    "FilterGroups": [
      {
        "Condition": "AND",
        "FilterItems": [],
        "FilterGroups": []
      },
      {
        "Condition": "OR",
        "FilterItems": [],
        "FilterGroups": []
      }
    ]
  }
}

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

200

OK

{
  "data": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "tags": [
          "text"
        ],
        "languages": [
          "text"
        ],
        "enrollmentId": "text",
        "name": "text",
        "enrolledBy": "text",
        "startDate": "2026-03-09T13:38:38.081Z",
        "trainingName": "text",
        "delivery": "text",
        "deliveryType": "text",
        "createTime": "2026-03-09T13:38:38.081Z",
        "isReminderActive": true,
        "isAutoEnrollmentActive": true,
        "status": "text",
        "recipientType": "text",
        "category": "text",
        "type": "text",
        "hasQuiz": true,
        "sendTemplatesInPreferredLanguage": true,
        "trainingRoles": [
          {
            "roleId": 1,
            "code": "text",
            "roleName": "text"
          }
        ],
        "duration": "text",
        "level": "text"
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

GET /api/enrollments/{resourceId}

Returns full details for one enrollment. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId> for the customer that owns this enrollment.

Get enrollment by Id

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

Responses

200

OK

application/json

statusstring · nullableOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

get

/api/enrollments/{resourceId}

HTTPcURLJavaScriptPython

GET /api/enrollments/{resourceId} HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "data": {
    "trainingId": "text",
    "name": "text",
    "learningPathId": "text",
    "trainingOrder": 1,
    "targetGroupResourceIds": [
      "text"
    ],
    "phishingCampaignResourceId": "text",
    "phishingCampaignConditionTypes": [
      "text"
    ],
    "languageIds": [
      "text"
    ],
    "enrollmentScheduler": {
      "scheduledDate": "2026-03-09T13:38:38.081Z",
      "scheduledTimeZoneId": "text",
      "useOwnTimeZone": true,
      "dueDate": "2026-03-09T13:38:38.081Z"
    },
    "enrollmentReminder": {
      "periodCount": 1,
      "periodType": "text",
      "endType": "text",
      "occurrenceCount": 1,
      "stopTime": "2026-03-09T13:38:38.081Z"
    },
    "enrollmentAutoEnroll": {
      "type": "text",
      "dayOfWeek": 1,
      "emailPeriodTypeEnum": "text",
      "periodCount": 1
    },
    "smsTexts": [
      {
        "type": "text",
        "providerNumberResourceId": "text",
        "template": "text"
      }
    ],
    "awardCertificate": true,
    "certificateConfigSendType": "text",
    "markedAsTest": true,
    "trainingTypeId": "text",
    "distributionDays": 1
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

GET /api/training-reports/{enrollmentId}/summary

Returns the enrollment summary (overview) for the survey. Send X-KEEPNET-Company-Id. For Survey enrollments you can pass the optional query parameter trainingType=0 if required by the API.

Returns enrollment summary report

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

enrollmentIdstringRequired

Query parameters

trainingTypestringOptional

Responses

200

OK

application/json

statusstring · nullableOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

get

/api/training-reports/{enrollmentId}/summary

HTTPcURLJavaScriptPython

GET /api/training-reports/{enrollmentId}/summary HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "data": {
    "trainingDetails": {
      "id": "text",
      "name": "text",
      "description": "text",
      "companyName": "text",
      "category": "text",
      "trainingTypeName": "text",
      "hasQuiz": true
    },
    "reportDetail": {
      "totalUserOpenedCount": 1,
      "totalTargetUserCount": 1,
      "onlyOpenedCount": 1,
      "totalNonTargetUserCount": 1,
      "emailDeliveredUserCount": 1,
      "emailErrorUserCount": 1,
      "noResponseCount": 1,
      "didNotCompleteTrainingCount": 1,
      "didNotCompleteExamCount": 1,
      "failedExamCount": 1
    },
    "startDate": "2026-03-09T13:38:38.081Z",
    "name": "text",
    "completedCount": 1,
    "inProgressCount": 1,
    "groupCount": 1,
    "targetGroupNames": [
      "text"
    ],
    "languages": [
      "text"
    ],
    "reminderDescription": "text",
    "autoEnrollDescription": "text",
    "reminderSettings": {
      "periodCount": 1,
      "periodType": "text",
      "endType": "text",
      "occurrenceCount": 1,
      "stopTime": "2026-03-09T13:38:38.081Z"
    },
    "autoEnrollSettings": {
      "type": "text",
      "dayOfWeek": 1,
      "emailPeriodTypeEnum": "text",
      "periodCount": 1
    },
    "trainingEmailNotificationTemplateTypeResourceId": "text",
    "certificateEmailNotificationTemplateTypeResourceId": "text",
    "certificateAttachmentResourceId": "text",
    "isTest": true,
    "isScormProxy": true,
    "smsSummary": {
      "providerNumberResourceId": "text",
      "smsPhoneNumber": "text",
      "template": "text",
      "sentCount": 1
    },
    "trainingTypeId": "text",
    "trainingTypeName": "text",
    "steps": [
      {
        "stepNumber": 1,
        "enrollmentId": "text",
        "trainingName": "text",
        "awardCertificate": true,
        "reportDetail": {
          "totalUserOpenedCount": 1,
          "totalTargetUserCount": 1,
          "onlyOpenedCount": 1,
          "totalNonTargetUserCount": 1,
          "emailDeliveredUserCount": 1,
          "emailErrorUserCount": 1,
          "noResponseCount": 1,
          "didNotCompleteTrainingCount": 1,
          "didNotCompleteExamCount": 1,
          "failedExamCount": 1
        },
        "trainingDetails": {
          "id": "text",
          "name": "text",
          "description": "text",
          "companyName": "text",
          "category": "text",
          "trainingTypeName": "text",
          "hasQuiz": true
        }
      }
    ],
    "distributionDescription": "text",
    "deliveryMethod": "text",
    "sendTemplatesInPreferredLanguage": true
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/training-reports/{enrollmentId}/users/search

Returns the per-user report for that survey enrollment — one row per user with status, progress, and related fields. Send X-KEEPNET-Company-Id. Request body: filter (required), pageNumber, pageSize, orderBy, ascending. For Survey enrollments include trainingType (e.g. 0) in the body if required. See Endpoints → TrainingReport for the full schema.

Returns target user training report for an enrollment

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:

Path parameters

enrollmentIdstringRequired

Body

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

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 100

orderBystringRequiredExample: Email

ascendingbooleanRequiredExample: true

trainingTypeinteger · nullableOptional

Optional: e.g. 0 for Survey enrollment

Responses

200

OK

application/json

statusstring · nullableOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/training-reports/{enrollmentId}/users/search

HTTPcURLJavaScriptPython

POST /api/training-reports/{enrollmentId}/users/search HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 141

{
  "pageNumber": 1,
  "pageSize": 100,
  "orderBy": "Email",
  "ascending": true,
  "filter": {
    "condition": "and",
    "searchInputTextValue": null,
    "filterGroups": []
  }
}

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

200

OK

{
  "data": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "firstCompletionDate": "2026-03-09T13:38:38.081Z",
        "lastInteractionDate": "2026-03-09T13:38:38.081Z",
        "deliveryType": "text",
        "phoneNumber": "text",
        "currentStep": "text",
        "status": "text",
        "examStatusName": "text",
        "examScore": 1,
        "lastInteractedStep": "text",
        "enrollmentId": "text",
        "targetUserResourceId": "text",
        "userId": 1,
        "resourceId": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "department": "text",
        "isMainScore": true,
        "customFieldValues": [
          {
            "resourceId": "text",
            "name": "text",
            "dataType": "text",
            "value": "text",
            "timestampValue": "2026-03-09T13:38:38.081Z"
          }
        ]
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

GET /api/training-reports/{enrollmentId}/interactions/{targetUserResourceId}

Returns per-user interaction data for the enrollment (e.g. survey question-level responses when the enrollment is a survey). Send X-KEEPNET-Company-Id. Use targetUserResourceId from the users/search response. See Endpoints → TrainingReport for the response shape.

Returns interactions for an user

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

enrollmentIdstringRequired

targetUserResourceIdstringRequired

Query parameters

emailEventTypestringOptional

trainingTypestringOptional

Responses

200

OK

application/json

statusstring · nullableOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

get

/api/training-reports/{enrollmentId}/interactions/{targetUserResourceId}

HTTPcURLJavaScriptPython

GET /api/training-reports/{enrollmentId}/interactions/{targetUserResourceId} HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "stepCount": 1,
      "interaction": "text",
      "learningPathId": "text",
      "trainingOrder": 1,
      "currentStep": "text",
      "eventTime": "2026-03-09T13:38:38.081Z",
      "trackingInfo": {
        "browserName": "text",
        "userAgent": "text",
        "userGeolocation": "text",
        "userIpAddresslist": "text"
      }
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

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.

• 400 Bad Request — Invalid request body. For POST /api/enrollments/search, ensure filter is sent with the required structure (e.g. Condition, FilterGroups). For survey-only results, include enrollmentType: "Survey". For users/search, include the required filter object.

• 404 Not Found — Invalid Company ID or enrollment ID. Verify Company ID from POST /api/companies/search and enrollment ID from POST /api/enrollments/search; send X-KEEPNET-Company-Id and x-ir-company-id for enrollment search.

Platform UI: View survey enrollments and reports under Awareness Educator → Enrollments. Enrollments →

Related: View customer's enrollment list and report →. View customer's enrollment sending, certificates, and notifications →. Scope API requests to a customer →.