API Overview

The Hellotime API is a RESTful API that provides comprehensive control over the Hellotime app.

The Hellotime API allows developers to programmatically interact with their Hellotime account and services through HTTP requests. With this API, developers can integrate Hellotime projects with their ERP, Google Sheets or whatever source they like.

The API is compatible with any programming language or framework capable of sending HTTP requests.

API Basics & URL

Our API is exposed as an HTTP/1 and HTTP/2 service over SSL. All endpoints live under the URL https://api.hellotime.io and generally follow the REST architecture.

API Authentication

To make API requests, you need to authenticate using an access token. Follow the steps below to obtain and use the token:

How to Obtain an Access Token

1. Create a Hellotime account (if you don’t already have one).
2. Generate an access token from the Hellotime dashboard.

Learn more on access tokens in Hellotime.

How to Use the Access Token

When making an API request, add a header called Authorization with the following format:

Authorization: Bearer <access_token>

Here’s an example of an API request using curl:

curl -X 'GET' \
  '<host>/v1/projects?page=1&pageSize=10&sort=createdAt&direction=ASC' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <access_token>'

Versioning

The current API exclusively pertain to the “Projects” associated with the selected Workspace. It is versioned starting from v1 using the path-versioning method (the versioning will be explicitly included in the API URI). The API allows the creation, retrieval, and deletion of projects within the workspace.

Rate limits

Endpoints are subject to a rate limit of 100 requests per 10 seconds and will return HTTP Error Code 429 when the limit is reached.