{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference Associated Persons associatedPersons API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "associatedPersons",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List associated persons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/employees/:employee_id/associated_persons",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "employee_id",
                "value": "",
                "type": "path"
              },
              {
                "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 all `associated person`'s for a specific `employee`. The `associated person`'s are returned sorted by creation date, with the most recent `associated person` appearing first."
        },
        {
          "info": {
            "name": "Create an associated person",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.kota.io/employees/:employee_id/associated_persons",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "employee_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an associated person (dependent or beneficiary) linked to an employee."
        },
        {
          "info": {
            "name": "Retrieve an associated person",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/employees/:employee_id/associated_persons/:associated_person_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "employee_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "associated_person_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves an associated person object."
        },
        {
          "info": {
            "name": "Update an associated person",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://test.api.kota.io/employees/:employee_id/associated_persons/:associated_person_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "employee_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "associated_person_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified associated person by setting the values of the parameters passed. Any parameters not provided will be left unchanged."
        },
        {
          "info": {
            "name": "Delete an associated person",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://test.api.kota.io/employees/:employee_id/associated_persons/:associated_person_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "employee_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "associated_person_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Permanently deletes an associated person. It cannot be undone."
        }
      ]
    }
  ],
  "bundled": true
}