ByteHR API Documentation

Introduction

Welcome to the ByteHR Open API documentation. This documentation provides information about the API endpoints, parameters, responses, authentication, and status codes.

Authentication

API requests require an API key for authentication. You must include the API key in the request headers as shown below:

Header Value
x-api-key YOUR_API_KEY

List API Enpoints

Reponse Status Codes

Status Code Description
200 OK The request response status code indicates that a request has succeeded.
400 Bad Request The request could not be understood or was missing required parameters.
401 Unauthorized Authentication failed or user does not have permissions for the desired action.
404 Not Found The requested resource could not be found.
429 Too Many Requests The request client error response status code indicates the client has sent too many requests in a given amount of time.
500 Internal Server Error An error occurred on the server.