API Reference
Home

v1/employments/info

get
https://shyftplan.com/api/v1/employments/info

List of employees available/working at shift schedule

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.

filters[employment_ids][]
array of int32s

Employment IDs

filters[employment_ids][]
date-time
required

End date in ISO 8601 format with time and UTC offset

filters[locations_position_ids][]
array of int32s

Locations position IDs

filters[locations_position_ids][]
filters[location_ids][]
array of int32s

Location IDs

filters[location_ids][]
filters[shift_rotation_group_ids][]
array of int32s

List of shift-system group IDs.

filters[shift_rotation_group_ids][]
date-time
required

Start date in ISO 8601 format with time and UTC offset

string

Search employee by the name or staff number

filters[tag_ids][]
array of int32s

Filter by an array of Employee Attribute IDs

filters[tag_ids][]
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 name

Sorting param

string
enum
Defaults to asc

Sorting order.
Available options:

  • asc: Ascending order
  • desc: Descending order
Allowed:
int32
≥ 1

When sort_name=time_accounts, this is the ID of the time-account absence reason to use for sorting.

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?