Skip to main content

​
🤖 What is the tipee API?

The tipee API facilitates the integration of external systems with our time management and HR platform. This document provides technical specifications for developers integrating with the API. For user guides and general help with tipee, please refer to the Help Center. Use of the tipee API is subject to the API Terms of Use.

​
API Fundamentals

The API operates over HTTPS and utilizes JSON for request and response bodies. The base URL for API calls depends on your specific tenant subdomain: 
https://<instance>.tipee.net/api/  # Replace <instance> with your usual tipee subdomain.

​
Prerequisites

To interact with the API, the following are required:
  1. You must have access to an active tipee instance.
  2. A valid API key must be included for authentication. Refer to the Authentication page for details on obtaining and using your key.
  3. The specific API version you intend to use must be specified in the request header (except for preview version). See the Versioning for details about versioning practices and usage instructions.
Additionally, an Accept header using the value application/json must be specified for most calls. Putting it all together, here is what a typical request to the API might look like:
  • If your request has a body :
POST https://<instance>.tipee.net/api/...

Accept: application/json
Content-Type: application/json
Authorization: Bearer <YOUR_API_KEY>
Tipee-Version: 25.09.01

<REQUEST BODY>
  • If your request does not have a body :
POST https://<instance>.tipee.net/api/...

Accept: application/json
Authorization: Bearer <YOUR_API_KEY>
Tipee-Version: 25.09.01