v2/employments

get

https://shyftplan.com/api/v2/employments

List all Employments.

Query Params

user_email

string

required

E-Mail of user

authentication_token

string

required

Authentication Token - can be fetched by login action

company_id

int32

Filter for single Company ID

page

int32

Defaults to 1

Pages start with 1

per_page

int32

Defaults to 1000

Between 1 and 1000

updated_after

date-time

Return all records which are updated after

created_after

date-time

Return all records which are created after

updated_before

date-time

Return all records which are updated before

created_before

date-time

Return all records which are created before

id

int32

Filter for single Employment ID

ids[]

array of int32s

Filter an array of Employment ID

ids[]

search

string

Search string to filter employees by name or staff number

staff_numbers[]

array of strings

Filter an array of Staff numbers ID

staff_numbers[]

company_ids[]

array of int32s

Filter an array of Company ID

company_ids[]

location_id

int32

Filter for Location ID

locations_position_id

int32

Filter for single LocationsPosition ID

locations_position_ids[]

array of int32s

Filter an array of LocationsPosition ID

locations_position_ids[]

shiftplan_id

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[]

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[]

is_stakeholder

boolean

Filter for managers.

is_owner

boolean

Filter for super-admins.

is_employee

boolean

Filter for Employees

invitation_state

string

enum

tbd

Allowed:

invitation_states[]

array of strings

tbd

invitation_states[]

include_live_info

boolean

Defaults to false

Include live info(might be slow)

include_custom_fields

boolean

Defaults to false

Include custom fields

with_deleted

boolean

Defaults to true

Include soft-deleted employments

qualification_id

int32

Filter for single Qualification ID

qualification_ids[]

array of int32s

Filter an array of Qualification ID

qualification_ids[]

tag_ids[]

array of int32s

Filter by an array of Employee Attribute IDs

tag_ids[]

access_level

string

enum

Defaults to all

Access level filter used for employments

Allowed:

order_key

string

enum

Defaults to last_name

Sort keys

Allowed:

order_dir

string

enum

Defaults to asc

Sort direction

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json