TimeStation - TimeStation API v0.1 (Beta)

TimeStation API v0.1 (Beta)

Overview
With the TimeStation API you can easily access your TimeStation data from other applications. The current version of the API (v0.1) provides access to all the TimeStation reports in CSV and XLS formats.

REST
The TimeStation API is organized around REST, a simple request format which uses an HTTP GET or POST action. The REST endpoint URL for the TimeStation API is

https://api.mytimestation.com/v0.1/

Authentication
The TimeStation API uses the api_key query string parameter to authenticate each request. TimeStation accounts can have a different API key for each application. To request an api_key for your account, please send an eMail to Support@MyTimeStation.com .

Example:
https://api.mytimestation.com/v0.1/reports/?api_key=4uahz4f7cvj29x63ew65vw3yf9p8rpeg

All requests to the TimeStation API must be sent using HTTPS. Requests sent using plain HTTP will fail.

Errors
TimeStation uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, etc.), and codes in the 5xx range indicate an error with TimeStation's servers.

200 OK - Everything worked as expected.
400 Bad Request - Often missing a required parameter.
401 Unauthorized - No valid API key provided.
402 Request Failed - Parameters were valid but request failed.
404 Not Found - The requested item doesn't exist.
500, 502, 503, 504 Server errors - something went wrong on TimeStation's end.

Not all errors map cleanly onto HTTP response codes, however. When an error occurs and more details are available about this error, that information can be found in the JSON response body as seen in the example below:

{"error":{"errorCode":"400", "errorText":"api_key parameter missing"}}

Versioning
When we make API changes that may affect compatibility with earlier versions we publish a new version of the API. The latest API version is v1.2, this document is for version 0.1 which is an older version. The API version is reflected in the REST endpoint URL.

You can find the documentation for other versions of the API below:

Rate Limiting
To ensure optimal performance for all API users, there's a limit of 5,000 API requests per TimeStation account per day.

Reports
The reports method allows you to execute a TimeStation report and receive the report output in either CSV or XLS format.

Common Parameters
All requests to the reports method require the following parameters

Parameter	Description
id	The report identifier - See list of reports below for details
exportformat	Response format. Must be either csv or xls

Example:
https://api.mytimestation.com/v0.1/reports/?api_key=4uahz4f7cvj29x63ew65vw3yf9p8rpeg&id=37&exportformat=csv

In addition to common parameters, each report may require specific additional parameters. See the table below for the list of parameters available for each report.

Available Reports

The following reports are available by calling the reports method

Report Name	Description	Parameters
Administrator List	Shows a list of all administrators with their permissions	id=78 Report Identifier
Attendance Counter	Shows the number of times each user checked-in within a given date range	id=38 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Attendance-Only	Shows a list of users present within a given date range	id=31 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
COVID-19 Screening Responses	Shows employee responses to COVID-19 screening questionnaires	id=84 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Current Device Status	Shows a list of devices associated with the account and their current status	id=68 Report Identifier
Current Employee Status	Shows the current attendance status (In/Out) of each user	id=37 Report Identifier
Daily Attendance & Absence	Shows a list of users present or absent during a specific day	id=33 Report Identifier Report_DayDate Date of the reporting period Format: YYYY-MM-DD
Department List	Shows a list of all the departments and the number of employees assigned to each department.	id=80 Report Identifier
Department Members	Shows a list of all members of a given department	id=36 Report Identifier
Department Summary	Shows hours worked and total pay for each department within a given date range	id=28 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Employee Activity	Shows a detailed log of employee activity (In/Out) within a given date range	id=34 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Employee Daily Summary	Shows daily hours for each employee within a given date range	id=42 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Employee Daily Summary - One Week	Shows daily hours for each employee during a one week period	id=41 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD
Employee Daily Summary - Two Weeks	Shows daily hours for each employee during a two week period	id=40 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD
Employee Details	Shows details of hours worked and pay for employees within a given date range	id=30 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Employee List	Shows a list of all employees with details.	id=35 Report Identifier Optional: Report_ShowDeletedEmployees Include Deleted Employees Values: 0 (Default) or 1
Employee Permissions	Shows the permissions granted to each employee	id=60 Report Identifier
Employee Summary	Shows a summary of hours worked and pay for each employee within a given date range	id=29 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Employee Weekday Summary	Shows total hours worked weekdays, Saturdays and Sundays for each employee within a given date range	id=39 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Inactive Employees	Shows a List of Employees that had no activity within a given period	id=47 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Manual Time Adjustments	Shows Time Entries that were manually adjusted	id=51 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Open Shifts	Shows shifts that are currently open or over a certain number of hours	id=64 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Payroll Export - Ctuit	Generates an export file for Ctuit payroll	id=55 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Payroll Export - Heartland	Generate an export file Heartland payroll	id=73 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Payroll Export - Paychex	Generate an export file for Paychex payroll	id=45 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD
Payroll Export - SurePayroll	Generate an export file SurePayroll	id=86 Report Identifier Report_StartDate Start date of the reporting period Format: YYYY-MM-DD Report_EndDate End date of the reporting period Format: YYYY-MM-DD