HomeGuidesAPI ReferenceChangelogDiscussions
API Reference
These docs are for v2.0. Click to read the latest docs for v2025-01-01.

Reads all Open shifts

This endpoint retrieves the current open shifts for the specified employee_ids.

Log in to see full request history
Query Params
employee_ids[]
array of integers

Employee ids to filter the open shifts by.

employee_ids[]
Response

Response body
array of objects
object
integer
required

Open Shift identifier.

integer
required

Employee identifier from the open shift.

string
required

Date of the open shift.

string
required

Clock in time from the shift. Ignore the date part.

string

For open shifts, this field is null.

string
required

Status of the shift

opened closed created

boolean
required

Indicates if the shift is a break or a workable shift.

boolean
required

Indicates if the shift is automatic or not

string

String representing the location type of the shift. Examples work_from_home, office, etc.

integer

Identifier for the workplace assinged to the shift.

integer

If the shift is a break, this field will have the break configuration id.

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json