v1/employments/hires_and_departures/list

get

https://shyftplan.com/api/v1/employments/hires_and_departures/list

Monthly hires vs. departures counts for a company.

Query Params

user_email

string

required

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

E-mail address of the API user.

authentication_token

string

required

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

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

starts_at

date

required

First day of the first month in the window. Any date within the target month is accepted; the window is expanded to the month boundary.

ends_at

date

required

Last day of the last month in the window. Any date within the target month is accepted; the window is expanded to the end of that month.

include_deleted

boolean

Defaults to false

When true, archived employments are counted. Default false.

location_ids[]

array of objects

Filter for a list of location IDs.

location_ids[]

Responses

200Successfully listed