Sign in
Employees

List employees

Changed on

The roster as we hold it. Every scalar is always present; a relation appears only when include names it.

status decides whether the people who left are in the answer — active by default, dismissed for only them, all for both. A dismissed employee keeps their record: date_leave says when they were let go and dismissed_at when the record was closed. A sync that never asks for them cannot learn that anyone left, so ask periodically even if your day-to-day reads are active.

external_ids is the other half of the roster write. Ask with the same keys you sent to /users/upsert and reconcile without keeping a map of our ids.

updated_since reads only what changed, against the updated_at every row carries.

get/company/v3/users

Request

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

Query parameters

per_pageinteger

How many rows one page holds. Defaults to 50.

cursorstring nullable

The meta.next_cursor of the previous page. Omit it for the first. A cursor is bound to the filters it was issued under — change them and start again.

searchstring nullable

Free text over the names the section lists.

updated_sincestring date-time nullable

Only rows changed at or after this instant (ISO 8601). The cheap way to sync: ask for what moved, not for everything.

status'active' | 'dismissed' | 'all'

Whether the people who left are in the answer: active, dismissed, or all.

idsinteger[] nullable

Only these ids.

codesstring[] nullable

Only these employee codes.

external_idsstring[] nullable

Only rows carrying these keys of yours. The other half of an upsert: write with your key, read back with it.

locationsinteger[] nullable

Only these locations, by id.

departmentsinteger[] nullable

Only these departments, by id.

positionsinteger[] nullable

Only these positions, by id.

user_filtersinteger[] nullable

Only these user filters, by id.

employmentstring[] nullable

Only people on these employment terms.

includestring[] nullable

Relations to load, comma-separated. Anything not named is absent from the answer rather than null.

Response

Success

Changes

  • v396f948c66816Revision changes
    • info

      the endpoint scheme security companyToken was added to the API

  • v3383b8f459f93Revision changes
    • info

      added the enum value apprenticeship to the property items/ of the query request parameter employment

    • info

      added the enum value contract_1 to the property items/ of the query request parameter employment

    • info

      added the enum value contract_2 to the property items/ of the query request parameter employment

    • info

      added the enum value full_time to the property items/ of the query request parameter employment

    • info

      added the enum value irregular_hours to the property items/ of the query request parameter employment

    • info

      added the enum value outstaffing to the property items/ of the query request parameter employment

    • info

      added the enum value part_time to the property items/ of the query request parameter employment

    • info

      added the enum value piece_rate to the property items/ of the query request parameter employment

    • info

      added the enum value probation to the property items/ of the query request parameter employment

    • info

      added the enum value traineeship to the property items/ of the query request parameter employment