{
  "opencollection": "1.0.0",
  "info": {
    "name": "Keystone Letters API",
    "version": "v12"
  },
  "items": [
    {
      "info": {
        "name": "Letters",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Companies/Employees/Letters/List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/letters",
            "params": [
              {
                "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": "operator",
                "value": "",
                "type": "query"
              },
              {
                "name": "company_id",
                "value": "1451",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "672",
                "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/Letters/List"
        },
        {
          "info": {
            "name": "Letters/Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/letters",
            "params": [
              {
                "name": "company_id",
                "value": "714",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "355",
                "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": "Letters/Create"
        },
        {
          "info": {
            "name": "Letters/Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/letters/:id",
            "params": [
              {
                "name": "id",
                "value": "7",
                "type": "path"
              },
              {
                "name": "company_id",
                "value": "717",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "358",
                "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": "Letters/Get"
        },
        {
          "info": {
            "name": "Companies/Employees/Letters/Update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/letters/:id",
            "params": [
              {
                "name": "company_id",
                "value": "1452",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "673",
                "type": "path"
              },
              {
                "name": "id",
                "value": "30",
                "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": "Companies/Employees/Letters/Update"
        },
        {
          "info": {
            "name": "Companies/Employees/Letters/Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/employees/:employee_id/letters/:id",
            "params": [
              {
                "name": "company_id",
                "value": "1454",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "675",
                "type": "path"
              },
              {
                "name": "id",
                "value": "32",
                "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": "Companies/Employees/Letters/Update"
        },
        {
          "info": {
            "name": "Companies/Letters/List with Historical Employee Data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/letters",
            "params": [
              {
                "name": "company_id",
                "value": "1153",
                "type": "path"
              },
              {
                "name": "include[]",
                "value": "include[]=employee",
                "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 letters for a company. When the 'exited_employees_visibility' feature flag is enabled,\nletters for employees who exited more than 6 weeks ago will display historical employee data\n(forename, surname, and national_insurance_number as they were at the time of exit) instead of current data.\nThis applies to the employee, recipient, and created_by associations.\n"
        },
        {
          "info": {
            "name": "Companies/Letters/Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/letters/:id",
            "params": [
              {
                "name": "company_id",
                "value": "1144",
                "type": "path"
              },
              {
                "name": "id",
                "value": "17",
                "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/Letters/Get"
        },
        {
          "info": {
            "name": "Companies/Letters/Postponement/Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/letters/postponement",
            "params": [
              {
                "name": "company_id",
                "value": "1156",
                "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": "Companies/Letters/Postponement/Create"
        },
        {
          "info": {
            "name": "Companies/Letters/Welcome/Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.autoenrolment.co.uk/companies/:company_id/letters/welcome",
            "params": [
              {
                "name": "company_id",
                "value": "1166",
                "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": "Companies/Letters/Welcome/Create"
        }
      ]
    }
  ],
  "bundled": true
}