v1/evaluation_breaks

get

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

List all break times for staff shifts

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

Filter for break times of an employee

employment_ids[]

array of int32s

Filter an array of employees

employment_ids[]

ends_at

date-time

Filter for evaluation breaks to

evaluation_ids[]

array of int32s

Filter an array of evaluations

evaluation_ids[]

int32

Filter for single Evaluation break ID

ids[]

array of int32s

Filter for an array of Evaluation break ID

ids[]

page

int32

≥ 1

Defaults to 1

Number of the page of responses to retrieve. First page: 1.

per_page

int32

1 to 1000

Defaults to 500

Number of responses on each page.

shift_id

int32

Filter for break times of a shift

shift_ids[]

array of int32s

Filter an array of shifts

shift_ids[]

staff_shift_id

int32

Filter for break times of a staff_shift

staff_shift_ids[]

array of int32s

Filter an array of staff_shifts

staff_shift_ids[]

starts_at

date-time

Filter for evaluation breaks from

Response

200

List all break times for staff shifts