Group Policies

Retrieve a group policy

Changed on

Retrieves a group_policy object.

get/group_policies/{group_policy_id}

Request

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

Path parameters

group_policy_idstring required
Example:gp_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

idstring required

Unique identifier for the group policy. Prefixed with gp_.

group_idstring

Identifier for the group associated with this group policy.

employer_idstring

Identifier for the employer associated with this group policy.

start_datestring date required

Policy start (effective) date in ISO 8601 (YYYY-MM-DD).

end_datestring date nullable

Policy end date (inclusive) in ISO 8601 (YYYY-MM-DD), or null if open-ended.

cancellation_datestring date nullable

Policy cancellation date (inclusive) in ISO 8610 (YYYY-MM-DD), or null if not applicable.

status'scheduled' | 'active' | 'expired' | 'cancelled' required
type'health_insurance' | 'life_assurance' required
linked_group_policy_idsstring[] required

The other group_policy objects bought together with this one as a single scheme — the policies created from the same multi-level purchase. Always present, and empty for a policy with no siblings.

objectstring

The object type

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

    • 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 optional property /////////////// to the response with the status

    • info

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