Getting Started

Introduction

The API-First Approach of CuteHR allows developers to integrate CuteHR with their own applications. CuteHR API is organised around REST.

Base URL

Base URL: https://api.cutehr.io

Authentication

CuteHR API uses bearer token based authentication.

In order to access protected resources, you will need to send the Authorization header with a valid token. You can obtain a vaid token by a POST request to login endpoint as given in the following API path.

Once you have a valid token, you can form the header as follows: Authorization: Bearer <token>

If authentication fails, HTTP status code 403 is returned.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Errors

CuteHR API uses conventional HTTP response codes to indicate the 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 failed given the information provided (e.g., a required parameter was omitted, a email failed, etc.). Codes in the 5xx range indicate an error with CuteHR's servers (these are rare).

HTTP Status Code Summary

Code Description
200 OK Everything worked as expected.
400 Bad Request The request was unacceptable, often due to missing a required parameter.
401 Unauthorized No valid Access token provided.
402 Request Failed The parameters were valid but the request failed.
404 Not Found The requested resource doesn't exist.
409 Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
429 Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 Server Errors Something went wrong on CuteHR's end. (These are rare.)

API Endpoints

Check the detailed documentations at https://apidocs.cutehr.io


Revision #9
Created Mon, Jul 29, 2019 8:52 AM by Gopal
Updated Wed, Jul 31, 2019 12:24 PM by Aman