Path parameters

• employer_id string Required

Query parameters

• page_size integer

  The maximum number of employees to return per page.

  Minimum value is 100, maximum value is 500. Default value is 200.

• page_number integer

  The page number to return in the list of employees.

  Minimum value is 1. Default value is 1.

Responses

• 200 application/json

  A paginated list of employees for the specified employer.

  Hide response attributes Show response attributes object

  • page_number integer Required

    The current page number.

  • page_size integer Required

    The number of items per page.

  • total_items integer Required

    The total number of items available.

  • items array[object] Required

    An array of Employee objects on the current page.

    Hide items attributes Show items attributes object

    • id string

      Unique identifier for the employee.

    • upload_id string

      ID of the file upload from which the employee was created (if applicable).

    • employer_id string

      Identifier for the employer associated with the employee.

    • email string(email) Required

      Email address of the employee.

    • created_at string(date-time) Required

      The date and time the employee record was created, in ISO 8601 format.

    • updated_at string(date-time) Required

      The date and time the employee record was last updated, in ISO 8601 format.

    • forename string Required

      The employee's first name.

    • surname string Required

      The employee's last name.

    • title string Required

      The employee's title, e.g., Mr., Mrs., Dr., etc.

    • date_of_birth string(date) Required

      The employee's date of birth, in YYYY-MM-DD format.

    • address_line1 string Required

      The first line of the employee's address.

    • postcode string Required

      The postal code of the employee's address.

    • national_insurance_number string Required

      The employee's National Insurance number.

    • employment_start_date string(date) Required

      The date the employee started their employment, in YYYY-MM-DD format.

    • exit_date string(date) Required

      The date the employee's employment ended, in YYYY-MM-DD format (if applicable).

    • opt_out_date string(date) Required

      The date the employee opted out of the pension scheme, in YYYY-MM-DD format (if applicable).

    • opt_in_date string(date) Required

      The date the employee opted into the pension scheme, in YYYY-MM-DD format (if applicable).

    • opt_out_window_start_date string(date) Required

      The date the employee's opt out window begins. This is the same date as they were created and enrolled on the scheme.

    • opt_out_window_end_date string(date) Required

      The date the employee's opt out window ends.

• 400 application/json

  Bad request, the request is malformed or contains invalid data.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.

• 401 application/json

  Unauthorized, the request requires authentication, and the provided credentials are either missing or incorrect.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.

• 404 application/json

  Employer not found, the specified employer_id does not match any existing employer.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.