v1/punch_events

get

https://shyftplan.com/api/v1/punch_events

List punch events for the employee within a given time range

Query Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

employment_id

int32

required

≥ 1

ID of the employment.

staff_shift_id

int32

≥ 1

When present, replaces the [starts_at, ends_at] window with the calendar day(s) the referenced staff_shift falls on (same-day shifts: full day; cross-day shifts: second half of the start date through first half of the end date).

starts_at

date-time

required

Only consider punch events after this date-time

ends_at

date-time

required

Only consider punch events before this date-time

Responses

200Successfully listed

401Unauthorized

403Forbidden

404Employment not found Company not found

422employment_id is missing starts_at is missing ends_at is missing company_id is missing