> ## Documentation Index
> Fetch the complete documentation index at: https://api.tipee.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# First steps

## 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*.

<Note>Go to [Changelog Notifications](/guides-and-resources/changelog-notifications) to subscribe to API alerts and updates.</Note>

## API Fundamentals

<CardGroup cols={2}>
  <Card title="HTTPS" icon="lock">
    All API communication is encrypted over HTTPS.
  </Card>

  <Card title="JSON" icon="brackets-curly">
    Request and response bodies use JSON format.
  </Card>
</CardGroup>

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

<Steps>
  <Step title="Active tipee instance">
    You must have access to an active tipee instance.
  </Step>

  <Step title="API key">
    A valid API key must be included for authentication.

    <Card title="Authentication" icon="key" href="/guides-and-resources/authentication">
      Learn how to obtain and use your API key.
    </Card>
  </Step>

  <Step title="API version">
    You must specify the API version in the request header.

    <Card title="Versioning" icon="code-pull-request" href="/guides-and-resources/versioning">
      Learn about versioning practices and usage instructions.
    </Card>
  </Step>
</Steps>

## Request examples

Putting it all together, here is what a typical request to the API might look like:

<Tabs>
  <Tab title="With body">
    ```
    POST https://<instance>.tipee.net/...

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

    <REQUEST BODY>
    ```
  </Tab>

  <Tab title="Without body">
    ```
    POST https://<instance>.tipee.net/api/...

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

## Going further

<Card title="Help Center" icon="book" href="https://help.tipee.net/en/">
  User guides and general help with tipee.
</Card>