Sign in
Locations

List locations

Changed on

Ordered by id and paged on a cursor: no page number, no total, and nothing repeated or skipped while the list is written to. A cursor issued for another ordering is refused rather than silently restarting the list.

Coordinates are numbers, and a latitude of exactly 0 is a coordinate rather than a missing one.

include=managers adds the employees who manage the location, as on departments and user filters.

get/company/v3/locations

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/locations
  • 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.

includestring[] nullable

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

codesstring[] nullable

Only these employee codes.

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.

Response

Success

Changes