{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference Associated Persons groups API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/groups",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "employer_id",
                "value": "",
                "type": "query",
                "description": "Filter by employer ID."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `pending`, `ready`, `archived`."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return. Defaults to 1 if not provided."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100."
              }
            ]
          },
          "docs": "Returns a list of your `groups`. The `groups` are returned sorted by creation date, with the most recent `groups` appearing first."
        },
        {
          "info": {
            "name": "Create a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.kota.io/groups",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a `group` for the specified `employer`."
        },
        {
          "info": {
            "name": "Retrieve a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/groups/:group_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a `group` object."
        },
        {
          "info": {
            "name": "Update a group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://test.api.kota.io/groups/:group_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified `group`. Only `name` and `description` can be updated. Any parameters not provided will be left unchanged."
        },
        {
          "info": {
            "name": "List employees in a group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/groups/:group_id/employees",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "",
                "type": "query",
                "description": "Filter by employee ID."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return. Defaults to 1 if not provided."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100."
              }
            ]
          },
          "docs": "Returns a list of `employees` in a `group` with their policies and enrolments. The `employees` are returned sorted by addition date, with the most recently added `employees` appearing first."
        },
        {
          "info": {
            "name": "Add an employee to a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.kota.io/groups/:group_id/employees",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds an existing employee to a `group`. The employee must belong to the same employer as the `group`. If there is a `group_policy` associated with the `group`, a corresponding `enrolment_intent` will be created for the employee."
        },
        {
          "info": {
            "name": "Check employee eligibility for a group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.kota.io/groups/:group_id/eligibility_check",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "group_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Checks whether an `employee` qualifies for a `group` without adding them to it. This is a dry-run eligibility check — the employee is not enrolled or added. The response includes provider and plan information."
        }
      ]
    }
  ],
  "bundled": true
}