Articles on: API

Hours API

The Hours API in XperienceHR provides a seamless interface for exporting employee attendance records, enabling external systems to integrate effortlessly for reporting, payroll, and workforce management.

This API allows businesses to retrieve detailed hourly time entries—including dates, timestamps, and project associations—in XML format. Authentication is enforced via an API key generated in the app configuration.

By leveraging the Hours API, organizations can automate attendance tracking, ensure accurate payroll calculations, and gain real-time insights into workforce productivity.

Overview



API Type: REST
Supported Formats: XML
API Key: Generated in the app configuration
Method: GET


Request Parameters



ParameterTypeRequiredDescription
attendanceFromstringStart of the period, formatted as YYYYMMDDhhmm (e.g., 202201010000 for Jan 1, 2022 00:00).
attendanceTostringEnd of the period, formatted as YYYYMMDDhhmm (e.g., 202201311159 for Jan 31, 2022 11:59).
clientCodestringCode of the client to filter records. Omit to retrieve hours for all clients.
apiKeystringYour API key.



Operations



Get All Hours for Period



Retrieves attendance records for the specified date range.

Endpoint



Get Hours for Period by Client



Retrieves attendance records for the specified date range, filtered by client.

Endpoint



HTTP Response Codes


2XX Success - Operation completed successfully.
4XX Client Error - Likely an issue with the request, such as incorrect parameters or insufficient permissions. Returns an error message in text or XML format.
5XX Server Error - Indicates a server issue. Report this error if encountered.

Updated on: 08/05/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!