Group Policy Intents

Retrieve a group policy intent

Changed on

Retrieves a group_policy_intent object.

get/group_policy_intents/{group_policy_intent_id}

Request

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

Path parameters

group_policy_intent_idstring required
Example:gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

idstring required

Unique identifier for the group policy intent

type'single' | 'multi_level'
group_idstring nullable required

Unique identifier for the group. Null only on a multi-level intent, whose groups are on its levels.

plan_idstring nullable required

Unique identifier for the plan. Null only on a multi-level intent, whose plans are on its levels.

quote_intent_idstring required

Unique identifier for the group quote intent this policy intent was created from

status'processing' | 'action_required' | 'pending_verification' | 'pending_provider_approval' | 'policy_created' | 'expired' | 'provider_rejected' | 'manual_renewal_gathering_required' required
due_datestring date-time nullable

Due date for the policy intent

group_policy_idsstring[] required

The group policies created for this intent, one per level, once they exist. Always present and empty until the intent reaches policy_created.

objectstring

Object type identifier

Example response

{
  "id": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "quote_intent_id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "due_date": "2024-12-01T00:00:00Z",
  "cost_sharing": {
    "member_count": {
      "adults": 123,
      "children": 123
    },
    "member_selection": {
      "partner": true,
      "children": true
    },
    "member_selection_percentage_based": {
      "partner": true,
      "children": true,
      "percentage": 123
    },
    "percentage": {
      "percentage": 123
    },
    "fixed_amount": {
      "monthly_amount": 123.45
    },
    "pooled_member_count": {
      "dependents": 123
    }
  },
  "items": [
    {
      "levels": [
        {
          "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "cost_sharing": {
            "member_count": {
              "adults": 123,
              "children": 123
            },
            "member_selection": {
              "partner": true,
              "children": true
            },
            "member_selection_percentage_based": {
              "partner": true,
              "children": true,
              "percentage": 123
            },
            "percentage": {
              "percentage": 123
            },
            "fixed_amount": {
              "monthly_amount": 123.45
            },
            "pooled_member_count": {
              "dependents": 123
            }
          },
          "coverage_selections": [
            {
              "configuration_id": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a",
              "options": [
                {
                  "option_id": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "group_policy_ids": [
    "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  ],
  "action_required": {
    "due_by": "2024-12-01T00:00:00Z"
  }
}

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