API Reference
Home

v1/employments

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

List all Employments.

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.

company_ids[]
array of int32s

Filter for an array of Company IDs.

company_ids[]
string
enum
Defaults to all

Access level filter used for employments

Allowed:
date-time

Return all records which are created after

date-time

Return all records which are created before

int32

Filter for single Employment ID

ids[]
array of int32s

Filter an array of Employment ID

ids[]
boolean
Defaults to true

Include live info(might be slow)

string
enum

tbd

Allowed:
invitation_states[]
array of strings

tbd

invitation_states[]
boolean

Filter for Employees

boolean

Filter for super-admins.

boolean

Filter for managers.

int32

Filter for single LocationsPosition ID

locations_position_ids[]
array of int32s

Filter an array of LocationsPosition ID

locations_position_ids[]
int32

Filter for Location ID

not_in_shift_rotation_group_ids[]
array of int32s

Filter for employments who are not in these shift-system groups

not_in_shift_rotation_group_ids[]
string
enum
Defaults to asc

Sort direction

Allowed:
string
enum
Defaults to last_name

Sort keys

Allowed:
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

Search string to filter employees by name or staff number

int32

Filter for single Shiftplan ID

shiftplan_ids[]
array of int32s

Filter an array of Shiftplan ID

shiftplan_ids[]
shift_rotation_group_ids[]
array of int32s

Filter for a list of shift-system group IDs.

shift_rotation_group_ids[]
staff_numbers[]
array of strings

Filter an array of Staff numbers ID

staff_numbers[]
tag_ids[]
array of int32s

Filter by an array of Employee Attribute IDs

tag_ids[]
int32

Filter for single Qualification ID

qualification_ids[]
array of int32s

Filter an array of Qualification ID

qualification_ids[]
date-time

Return all records which are updated after

date-time

Return all records which are updated before

boolean
Defaults to true

Include soft-deleted employments

Responses

400

Error

Updated 3 days ago

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

Updated 3 days ago