> For the complete documentation index, see [llms.txt](https://docs.samesystem.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.samesystem.dev/getting-started/choose-the-right-api.md).

# Choose the right API

SameSystem provides two APIs: **API v1** and **API v2**. The APIs offer different endpoints and capabilities, and depending on your integration requirements, you may need to use one or both.

{% tabs %}
{% tab title="API v1" %}
API v1 provides access to:

* Departments
* Sales data
* Sales budgets
* Users
* Planned schedules
* Actual schedules
* Time registrations
* Absences
* Absence types

API v1 provides access to functionality that is not currently available through API v2 and is used by many existing SameSystem integrations.

**API v1 remains supported, and there are currently no plans to deprecate or discontinue it.** However, API v1 is primarily maintained for existing functionality. New endpoints and capabilities are generally introduced in API v2, while new functionality is only added to API v1 on a limited basis.
{% endtab %}

{% tab title="API v2" %}
API v2 provides access to:

* Users
* Contracts
* Titles
* Absence balances
* Period absences
* Groups, including district groups to create department hierarchies

**API v2 is the recommended API for new development.**

It provides access to newer SameSystem functionality and is where new endpoints and capabilities are primarily introduced.
{% endtab %}
{% endtabs %}

### User and employee integrations

For all user-related integrations, particularly integrations supporting Joiner, Mover, and Leaver processes, we strongly recommend using API v2.

API v2 provides a more complete user and employment data model through its Users and Contracts endpoints and should be the starting point for any new HR and employee lifecycle integrations.

### Using both APIs

You are not limited to using only one API and API v1 and API v2 are not mutually exclusive.

If your integration requires functionality that is available across both APIs, they can be used together. For example, an integration may use API v2 for employee and contract data while using API v1 for schedules, time registrations, or sales data.

When starting a new integration, we recommend checking **API v2 first** and using API v1 where the required functionality is not currently available in API v2.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.samesystem.dev/getting-started/choose-the-right-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.