Skip to main content

What is the tipee API?

The tipee API allows you to integrate external systems with our time management and HR platform. This documentation provides technical specifications for developers integrating with the API. Use of the tipee API is subject to the API Terms of Use.
Go to Changelog Notifications to subscribe to API alerts and updates.

API Fundamentals

HTTPS

All API communication is encrypted over HTTPS.

JSON

Request and response bodies use JSON format.
The base URL for API calls depends on your specific tenant subdomain:
https://<instance>.tipee.net
Replace <instance> with your usual tipee subdomain. An Accept header with the value application/json must be included in most requests.

Prerequisites

1

Active tipee instance

You must have access to an active tipee instance.
2

API key

A valid API key must be included for authentication.

Authentication

Learn how to obtain and use your API key.
3

API version

You must specify the API version in the request header (except for the preview version).

Versioning

Learn about versioning practices and usage instructions.

Request examples

Putting it all together, here is what a typical request to the API might look like:
POST https://<instance>.tipee.net/...

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

<REQUEST BODY>

Going further

Help Center

User guides and general help with tipee.