API Reference
Home

v1/hour_accounts/export

get
https://shyftplan.com/api/v1/hour_accounts/export

Request an overview of hour accounts and their data aggregations. The report file will be sent to the requesting user's e-mail address, as a zipped (.zip) attachment.

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.

int32
enum
required
1 to 12

Number of the month, 1-based (1 - January, ..., 12 - December).

int32
enum
required

Year in format YYYY.

string
enum
required

Format of the exported data.

Allowed:
employment_ids[]
array of objects

Filter for a list of employment IDs.

employment_ids[]
tag_ids[]
array of objects

Filter for a list of employment-tag IDs.

tag_ids[]
employment_statuses[]
array of objects

Filter for a list of employment statuses.

employment_statuses[]
int32

Filter for the minimum hour account balance. Value in minutes.

int32

Filter for the maximum hour account balance. Value in minutes.

location_ids[]
array of objects

Filter for a list of location IDs.

location_ids[]
locations_position_ids[]
array of objects

Filter for a list of locations position IDs.

locations_position_ids[]
Responses

Updated 6 months ago

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

Updated 6 months ago