{
  "opencollection": "1.0.0",
  "info": {
    "name": "Keystone Employee API",
    "version": "v12"
  },
  "items": [
    {
      "info": {
        "name": "Employee",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "ActivePayrollConfiguration/Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/active_payroll_configuration",
            "params": [
              {
                "name": "company_id",
                "value": "240",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "57",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "ActivePayrollConfiguration/Get"
        },
        {
          "info": {
            "name": "Companies/Employees/List with Historical Employee Data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees",
            "params": [
              {
                "name": "company_id",
                "value": "725",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "include[]",
                "value": "",
                "type": "query"
              },
              {
                "name": "operator",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Lists employees for a company. When the 'exited_employees_visibility' feature flag is enabled,\nemployees who exited more than 6 weeks ago will display historical employee data\n(forename, surname, national_insurance_number, email, gender, date_of_birth, and telephone\nas they were at the time of exit) instead of current data. These records are marked with\n'is_not_editable: true' to indicate they should not be modified.\n"
        },
        {
          "info": {
            "name": "Employees/Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees",
            "params": [
              {
                "name": "company_id",
                "value": "564",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/Create"
        },
        {
          "info": {
            "name": "Companies/Employees/Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:id",
            "params": [
              {
                "name": "id",
                "value": "305",
                "type": "path"
              },
              {
                "name": "company_id",
                "value": "635",
                "type": "path"
              },
              {
                "name": "include[]",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Companies/Employees/Get"
        },
        {
          "info": {
            "name": "Employees/Update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:id",
            "params": [
              {
                "name": "company_id",
                "value": "950",
                "type": "path"
              },
              {
                "name": "id",
                "value": "532",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/Update"
        },
        {
          "info": {
            "name": "Employees/Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:id",
            "params": [
              {
                "name": "company_id",
                "value": "959",
                "type": "path"
              },
              {
                "name": "id",
                "value": "535",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/Update"
        },
        {
          "info": {
            "name": "Companies/Employees/Destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:id",
            "params": [
              {
                "name": "id",
                "value": "256",
                "type": "path"
              },
              {
                "name": "company_id",
                "value": "570",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Companies/Employees/Destroy"
        },
        {
          "info": {
            "name": "Employees/MovedToEuCompany",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:id/moved_to_eu_company",
            "params": [
              {
                "name": "company_id",
                "value": "729",
                "type": "path"
              },
              {
                "name": "id",
                "value": "364",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/MovedToEuCompany"
        },
        {
          "info": {
            "name": "Companies/Employees/OptStates/Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:id/opt_state",
            "params": [
              {
                "name": "id",
                "value": "367",
                "type": "path"
              },
              {
                "name": "company_id",
                "value": "734",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Companies/Employees/OptStates/Get"
        },
        {
          "info": {
            "name": "Employees/RecurringContributionSchedule/Show",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/recurring_contribution_schedule",
            "params": [
              {
                "name": "company_id",
                "value": "1491",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "708",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/RecurringContributionSchedule/Show"
        },
        {
          "info": {
            "name": "Employees/RecurringContributionSchedule/Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/recurring_contribution_schedule",
            "params": [
              {
                "name": "company_id",
                "value": "1465",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "686",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/RecurringContributionSchedule/Create"
        },
        {
          "info": {
            "name": "Employees/RecurringContributionSchedule/Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/recurring_contribution_schedule",
            "params": [
              {
                "name": "company_id",
                "value": "1494",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "711",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/RecurringContributionSchedule/Update"
        },
        {
          "info": {
            "name": "Employees/RecurringContributionSchedule/Destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/recurring_contribution_schedule",
            "params": [
              {
                "name": "company_id",
                "value": "1489",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "706",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/RecurringContributionSchedule/Destroy"
        },
        {
          "info": {
            "name": "Employees/Retirement",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/employees/retirement",
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/Retirement"
        },
        {
          "info": {
            "name": "Employees/RetirementOptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/employees/retirement_options",
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/RetirementOptions"
        },
        {
          "info": {
            "name": "Employees/Session",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/employees/session",
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/Session"
        },
        {
          "info": {
            "name": "Employees/SingleContributionPayments/Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/single_contribution_payments",
            "params": [
              {
                "name": "company_id",
                "value": "1523",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "736",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/authorize",
              "accessTokenUrl": "https://id.sandbox.autoenrolment.co.uk/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Employees/SingleContributionPayments/Create"
        }
      ]
    }
  ],
  "bundled": true
}