Open API **Add-On

ByteHR Open API enables scalable and flexible data integration by allowing companies to securely extract raw data directly from the system. It supports both standard system data and admin-defined Custom Fields, making it easy to connect ByteHR with internal platforms, data warehouses, BI tools, or automation workflows.

With comprehensive API Documentation, development teams can integrate faster, reduce implementation time, and build custom solutions on top of ByteHR with confidence.

Pricing for the Open API feature is based on the number of employees in your package and is prorated according to your billing cycle. Please contact our team for more details.

Note📝

Q1: Is there a limit on the number of Open API requests?

A1: Yes. Each company / API key is limited to 1,000 requests per month.

—

Q2: Does the API key expire?

A2: Yes. Each API key has a 1-year expiration period.

If the API key expires, users must reset the API key to continue using the Open API.

—

Q3: What is the maximum number of records per request?

A3: The maximum number of records per request is 100 records.

The default value is 10 records per request.

—

Q4: Does the Open API support pagination?

A4: Yes. The system supports pagination.

Each API request returns one page of data.

Users can specify the number of records per page and the page number via query parameters.

Example:

https://developer.byte-hr.com/api/employees?limit=2&currentpage=4

limit: number of records per page

currentpage: page number to retrieve

—

Q5: Why does the API return only part of the data?

A5: Because there is a limit on the number of records per request.

If the total number of records exceeds the specified limit, the system will return only the records within that limit.

To retrieve all data, users must make multiple API calls using pagination.

—

Q6: If there are 100 records in total but the limit is set to 10, what will happen?

A6: The system will return only the first 10 records.

To retrieve the remaining records, users need to call the API again with a different currentpage value.

—

Q7: What happens when the monthly request limit is reached?

A7: Once the monthly request limit is reached, the system will not allow additional API requests until the next monthly cycle starts.