API Reference
Home

/api/v1/time_recordings

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

List all Time Recordings.

Query Params
string
required

E-Mail of user

string
required

Authentication Token - can be fetched by login action

int32
required

ID of a Company.

date

Start date for the statistics

date

End date for the statistics

int32
Defaults to 1

Pages start with 1

int32
Defaults to 1000

Between 1 and 1000

string
enum
Defaults to evaluation_starts_at

Sorting param

Allowed:
string
enum
Defaults to asc

Sorting direction

Allowed:
string
Defaults to null

One time password for export time recordings

states[]
array of strings

Filter by time recording states

states[]
Allowed:
shiftplan_ids[]
array of int32s

Filter an array of Shiftplan ID

shiftplan_ids[]
employment_ids[]
array of int32s

Filter an array of Employment ID

employment_ids[]
employment_statuses[]
array of strings

Filter by employment statuses

employment_statuses[]
Allowed:
employment_tag_ids[]
array of int32s

Filter by employment tag IDs

employment_tag_ids[]
shift_tag_ids[]
array of int32s

Filter by shift tag IDs

shift_tag_ids[]
staff_shift_tag_ids[]
array of int32s

Filter by staff shift tag IDs

staff_shift_tag_ids[]
location_ids[]
array of int32s

Filter an array of Location ID

location_ids[]
locations_position_ids[]
array of int32s

Filter an array of Locations Position ID

locations_position_ids[]
Responses

Updated about 1 month 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 about 1 month ago

Did this page help you?