Enrolment Intents

Retrieve an enrolment intent

Changed on

Retrieves an enrolment_intent object.

get/enrolment_intents/{enrolment_intent_id}

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/enrolment_intents/{enrolment_intent_id}
  • Auth
    HTTP bearer

Path parameters

enrolment_intent_idstring required
Example:ei_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

idstring required

Unique identifier for the enrolment intent. Prefixed with ei_.

employee_idstring required

Identifier for the employee associated with this enrolment intent. Prefixed with ee_.

group_idstring required

Identifier for the group associated with this enrolment intent. Prefixed with gr_.

status'processing' | 'scheduled' | 'action_required' | 'coverage_options_required' | 'pending_confirmation' | 'enrolling' | 'enrolled' | 'not_undertaken' | 'ineligible' | 'rejected' required
force_confirmationboolean required

If set to true, the system will always force the PendingConfirmation state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.

objectstring

Object type identifier.

Changes

  • 998f7cb004abRevision changes
    • warning

      deleted the header request parameter X-Platform-Id

  • ce9736d28f93Revision changes
    • warning

      added the new pooled_member_count enum value to the ///////////////////// response property for the response status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the required property //////////// to the response with the status