API Reference
Home

v1/staff_shifts

get
https://shyftplan.com/api/v1/staff_shifts

List all StaffShifts.

Query Params
string
required

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

E-mail address of the API user.

string
required

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

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

date-time

Return all records which are created after

date-time

Return all records which are created before

int32

Filter for single Employment ID

employment_ids[]
array of int32s

Filter an array of Employment ID

employment_ids[]
date-time
int32

Filter for single StaffShift ID

ids[]
array of int32s

Filter an array of StaffShift ID

ids[]
boolean
Defaults to false

Filter for open shifts - employment_id needs to be present

int32
≥ 1
Defaults to 1

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

int32
1 to 1000
Defaults to 500

Number of responses on each page.

int32

Filter for single Shiftplan ID

shiftplan_ids[]
array of int32s

Filter an array of Shiftplan ID

shiftplan_ids[]
int32

Filter for single Shift ID

shift_ids[]
array of int32s

Filter an array of Shift ID

shift_ids[]
date-time
string
enum

State of the evaluation.

Allowed:
date-time

Return all records which are updated after

date-time

Return all records which are updated before

Responses

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?