/

Docs
History
Schema
Generate

Filter operations

Public56

get/v1/public/doc/urlreturns the documentation URL
get/v1/public/meGet company name
get/v1/public/calendar/{id}.icsGet your calendar url
post/v1/public/events/getGet events (shifts)
get/v1/public/eventsGet events (shifts)
post/v1/public/eventsCreate an event (assigned shift and open shift)
post/v1/public/events/import-fileCreate or update events (shifts) through a CSV file
get/v1/public/events/{eventId}Get an event (shift) by uid or externalId
patch/v1/public/events/{eventId}Update an existing event. The id can be an UID or an externalId
post/v1/public/events/publish/periodPublish events occurring during a specific period of time. This operation runs asynchronously and will return immediately.
post/v1/public/events/{eventId}/assignAssign an employee to a shift (open or already assigned)
post/v1/public/events/{eventId}/cancelCancel a shift
post/v1/public/events/{eventId}/restoreRestore a canceled shift
post/v1/public/events/{eventId}/replacementCreate an open replacement request or a reassignment
post/v1/public/events/open/bulkConvert assigned shifts to open shifts
get/v1/public/locationsGet company locations
post/v1/public/locationsCreate a new location
patch/v1/public/locations/{locationId}Update a location
get/v1/public/locations/{locationId}/subLocations/{subLocationId}Get a sub location
delete/v1/public/locations/{locationId}/subLocations/{subLocationId}delete a sub location
patch/v1/public/locations/{locationId}/subLocations/{subLocationId}Update a sub location
post/v1/public/locations/{locationId}/subLocationsCreate a new sub location
get/v1/public/membersGet members (employees)
post/v1/public/membersCreate a member (employee)
get/v1/public/members/{memberId}Get a member (employee)
patch/v1/public/members/{memberId}Update a member (employee)
get/v1/public/members/{memberId}/upcomingEventsGet member (employee) upcoming events (shifts)
get/v1/public/members/{memberId}/notesGet member (employee) notes
post/v1/public/members/{memberId}/notesAdd a note to a member (employee)
delete/v1/public/members/{memberId}/notes/{memberNoteId}Delete a member (employee) note
patch/v1/public/members/{memberId}/notes/{memberNoteId}Update a member (employee) note
post/v1/public/members/import-fileImport (create or update) members (employees) through a csv file
patch/v1/public/members/relationships/addAdd structural relationships to members
patch/v1/public/members/relationships/removeRemove structural relationships to members
post/v1/public/availabilities/dates/getGet days availabilities
post/v1/public/members/{memberId}/availabilities/datesCreate availabilities for a member (employee)
delete/v1/public/availabilities/dates/{availabilityId}Delete availability
patch/v1/public/availabilities/dates/{availabilityId}Update availability
post/v1/public/availabilities/weekdays/getGet weekdays availabilities
post/v1/public/members/{memberId}/availabilities/weekdaysCreate weekdays availabilities for a member (employee)
delete/v1/public/availabilities/weekdays/{availabilityId}Delete weekdays availability
patch/v1/public/availabilities/weekdays/{availabilityId}Update weekdays availabilities
get/v1/public/leavesGet leave requests
post/v1/public/leavesCreate a leave request
patch/v1/public/leaves/{leaveId}Update a leave request
get/v1/public/leaves/banksGet leave banks
get/v1/public/skillsGet company positions (skills)
post/v1/public/skillsCreate a position (skill)
patch/v1/public/skills/{skillId}Update a position (skill)
get/v1/public/timesheetsGet time entries (timesheet) for a specific period
post/v1/public/time-entries/getGet time entries for a specific period. This endpoint uses POST to allow large values in its body parameters
get/v1/public/time-entriesGet time entries for a specific period
get/v1/public/teamsGet company teams
post/v1/public/teamsCreate a team
patch/v1/public/teams/{teamId}Update a team
get/v1/public/budgetsGet company budgets

time-clock2

Public

Changes to Get leave banks

get/v1/public/leaves/banks

Sep 25, 20265f1c35aaddb3 Revision changes
- info
  added the optional property / to the response with the status