Employees

Create or update employees

Changed on

The roster, written in batches of up to 100. external_id is optional here and behaves as it does everywhere: an item carrying one updates the person it names, an item without one always creates. first_name, role and location_id are the minimum.

The field set is what an HR system holds about an employee.

A person created here reaches the turnstiles of their location, and every location's devices are told once for the whole batch rather than once per person.

post/company/v3/users/upsert

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/users/upsert
  • Auth: HTTP bearer

Request body

Response

Success

Changes

    • info

      the endpoint scheme security companyToken was added to the API

    • breaking

      the // request property format changed from no format to email

    • warning

      the // request property's maxLength was set to 255