API Reference
Home

v1/shiftplans/{id}/employments_info

get deprecated
https://shyftplan.com/api/v1/shiftplans//employments_info

DEPRECATED: List of employees available/working at shift schedule

Path Params
int32
required
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
required

Start date in ISO 8601 format with time and UTC offset

date-time
required

End date in ISO 8601 format with time and UTC offset

filters[employment_ids][]
array of int32s

Employment Ids

filters[employment_ids][]
filters[locations_position_ids][]
array of int32s

Locations position Ids

filters[locations_position_ids][]
filters[shift_rotation_group_ids][]
array of int32s

Shift-system group IDs.

filters[shift_rotation_group_ids][]
string

Search employee by the name or staff number

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.

string
enum
Defaults to asc

Sorting order.
Available options:

  • asc: Ascending order
  • desc: Descending order
Allowed:
string
enum
Defaults to name

Sorting param

Responses

Updated 6 months ago

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

Updated 6 months ago