View customer's enrollment sending, certificates, and notifications

As a Reseller you can view a customer's training enrollment sending report (emails sent, delivery status), certificates, reminder mails, and notification activity logs for a specific enrollment. Get the customer's Company ID and the enrollment ID from the enrollment list, then call the training-report and enrollment endpoints with X-KEEPNET-Company-Id so results are scoped to that customer. Use a credential with Client Role = Reseller.


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
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : API
Authorizations
OAuth2clientCredentialsRequired

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

Token URL:
Body
pageNumberintegerRequiredExample: 1
pageSizeintegerRequiredExample: 10
orderBystringRequiredExample: CreateTime
ascendingbooleanRequiredExample: false
isTargetUserCountExceededLimitbooleanOptional

If true, only companies exceeding license limit are returned

Example: false
Responses
chevron-right
200

OK

application/json
statusstringOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/companies/search
200

OK

From the response, pick the company and note its resourceId. Example: "resourceId": "xC5kfGz7w2Nz" → use as X-KEEPNET-Company-Id in all following requests.


POST /api/enrollments/search

Get the customer's enrollment list so you can choose an enrollment to inspect. Send X-KEEPNET-Company-Id. From the response, take the resourceId of the enrollment you want (e.g. "resourceId": "eNrl9Ab3k2Qp") — that is the enrollmentId for the sending, certificates, reminder, and notification endpoints below.

Returns a list of enrollments. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>. Request body: filter (required — use the structure with Condition, SearchInputTextValue, FilterGroups; see View customer's enrollment list and report for a full example), optional pageNumber, pageSize, orderBy, ascending, enrollmentType.

Returns a list of enrollments

post
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : API
Authorizations
OAuth2clientCredentialsRequired

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

Token URL:
Body
pageNumberintegerRequiredExample: 1
pageSizeintegerRequiredExample: 20
orderBystringRequiredExample: CreateTime
ascendingbooleanRequiredExample: false
enrollmentTypestringOptional

Optional: use "Survey" to list only survey enrollments

Example: Survey
Responses
chevron-right
200

OK

application/json
statusstring · nullableOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/enrollments/search
200

OK


POST /api/training-reports/{enrollmentId}/sending-report/search

Returns the sending report for that enrollment: emails sent, delivery status, and related data. Send X-KEEPNET-Company-Id. Replace {enrollmentId} with the enrollment resourceId from the enrollment list.

Returns sending report training report for an enrollment. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Returns sending report training report for an enrollment

post
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : API
Authorizations
OAuth2clientCredentialsRequired

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

Token URL:
Path parameters
enrollmentIdstringRequired
Body
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
orderBystring · nullableOptional
ascendingbooleanOptional
Responses
chevron-right
200

OK

application/json
statusstring · nullableOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/training-reports/{enrollmentId}/sending-report/search
200

OK

To export: POST /api/training-reports/{enrollmentId}/sending-report/search/export — same header and body shape; see Endpoints → TrainingReport.


POST /api/enrollments/{enrollmentId}/certificates/search

Search certificates issued for that enrollment. Send X-KEEPNET-Company-Id. Replace {enrollmentId} with the enrollment resourceId.

Search enrollment certificates. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Search enrollment certificates

post
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : API
Authorizations
OAuth2clientCredentialsRequired

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

Token URL:
Path parameters
enrollmentIdstringRequired
Body
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
orderBystring · nullableOptional
ascendingbooleanOptional
Responses
chevron-right
200

OK

application/json
statusstring · nullableOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/enrollments/{enrollmentId}/certificates/search
200

OK


POST /api/training-reports/{enrollmentId}/reminder-mails/search

Returns reminder mails sent for that enrollment (e.g. training reminders). Send X-KEEPNET-Company-Id. Replace {enrollmentId} with the enrollment resourceId.

Returns reminder mails for enrollment mails. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Returns reminder mails for enrollment mails

post
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : API
Authorizations
OAuth2clientCredentialsRequired

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

Token URL:
Path parameters
enrollmentIdstringRequired
Body
trainingTypestringOptional
reportAllPagesbooleanOptional
showByExamStatusstringOptional
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
orderBystring · nullableOptional
ascendingbooleanOptional
Responses
chevron-right
200

OK

application/json
statusstring · nullableOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/training-reports/{enrollmentId}/reminder-mails/search
200

OK


POST /api/notifications/{enrollmentId}/search

Search notification activity logs for that enrollment (e.g. email/Teams notifications). Send X-KEEPNET-Company-Id. Replace {enrollmentId} with the enrollment resourceId.

Search notification activity logs with filtering and pagination. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Search notification activity logs with filtering and pagination

post
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : API
Authorizations
OAuth2clientCredentialsRequired

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

Token URL:
Path parameters
enrollmentIdstringRequired
Body
companyIdinteger · int32Optional
enrollmentIdstring · nullableOptional
statusstringOptional
typestringOptional
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
orderBystring · nullableOptional
ascendingbooleanOptional
Responses
chevron-right
200

OK

application/json
statusstring · nullableOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/notifications/{enrollmentId}/search
200

OK


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 enrollment ID. Verify Company ID from POST /api/companies/search and enrollment ID from POST /api/enrollments/search; ensure you send X-KEEPNET-Company-Id for the customer that owns the enrollment.

Related: Scope API requests to a customer →. View customer's enrollment list and report → (list enrollments and summary). For enrollment and training endpoints: see EndpointsEnrollment, TrainingReport in the API Reference.

Last updated