> For the complete documentation index, see [llms.txt](https://help.join.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.join.com/help-center/de/integrations-and-api/api-documentation.md).

# API-Dokumentation

Erstellen Sie ein API-Token, authentifizieren Sie Anfragen an die JOIN API v3 und erfahren Sie, wie Versionen, Rate Limits, Paginierung und Fehler funktionieren.

{% hint style="info" %}
**Wer kann das nutzen**

* **Pläne:** Advanced und Enterprise
* **Rollen:** System-Admins
  {% endhint %}

## Erste Schritte

Diese Referenz hilft Ihnen beim Einstieg in die JOIN API v3, die REST-API von JOIN. Mit der API können Sie programmatisch mit Ihren JOIN-Daten arbeiten, zum Beispiel um Stellenanzeigen und Bewerbungen abzurufen oder Kandidat:innen-Datensätze zu verwalten.

Die JOIN API ist zustandslos. Das bedeutet, dass jede Anfrage eine Authentifizierung enthalten muss und nicht auf vorherigen Interaktionen aufbaut. Um die API zu nutzen, müssen Sie in JOIN ein API-Token erstellen.

Alle v3-Anfragen gehen an `https://api.join.com/v3`.

<a href="https://docs.join.com/reference/getting-started" class="button primary">Vollständige API-Dokumentation lesen</a>

***

## Authentifizierung

Um Ihre API-Anfragen zu validieren, benötigt JOIN ein API-Token. Das Token gehört Ihrem Unternehmen, nicht einzelnen Nutzer:innen. Es gewährt nur Zugriff auf die Daten Ihres Unternehmens in JOIN.

Der Zugriff auf die JOIN API, einschließlich API-Zugangsdaten und Token-Erstellung, ist nur im `Advanced`- und `Enterprise`-Plan verfügbar.

{% hint style="info" %}
Sie sehen die Seite `Entwickler` nicht? Nur System-Admins können sie öffnen. Wenn `Token erstellen` einen Upgrade-Hinweis öffnet, prüfen Sie Ihren Plan: Klicken Sie unten links auf Ihren Namen, wählen Sie `Einstellungen` und dann `Abrechnung`. Wechseln Sie zu `Advanced` oder `Enterprise`, um die JOIN API zu nutzen und Zugangsdaten zu erstellen.

Details zu den Plänen und zum Upgrade finden Sie unter [Abonnementpläne](https://help.join.com/help-center/de/plans-and-billing/subscription-plans.md).
{% endhint %}

### API-Token erstellen

1. Klicken Sie unten links auf Ihren Namen und wählen Sie `Einstellungen`.
2. Wählen Sie `Entwickler`.
3. Klicken Sie auf `Token erstellen`, geben Sie einen Namen ein und kopieren Sie das Token aus dem Fenster, das sich öffnet. Es wird nur einmal angezeigt.

Ihr Unternehmen kann bis zu 10 aktive Tokens haben.

{% hint style="warning" %}
Bewahren Sie Ihr API-Token sicher auf. Es ermöglicht den Zugriff auf Ihre Unternehmensdaten in JOIN, einschließlich der Möglichkeit, Informationen zu lesen, zu aktualisieren oder zu löschen.
{% endhint %}

### API-Token verwenden

Senden Sie Ihr Token in jeder Anfrage im `Authorization`-Header als Bearer-Token mit: `Authorization: Bearer join_sk_…`. Neue Tokens beginnen mit `join_sk_`.

Eine Anfrage ohne Token gibt `401 authentication_required` zurück. Ein ungültiges oder widerrufenes Token oder ein Token in einem Plan ohne API-Zugriff gibt `401 token_invalid` zurück.

### API-Version wählen

Die JOIN API v3 ist nach Datum versioniert. Senden Sie den Header `Join-Version`, um eine Version zu wählen. Ohne diesen Header verwendet JOIN `2026-11-01`. Eine unbekannte Version gibt `400 unsupported_api_version` zurück.

Wir empfehlen, `Join-Version` bei jeder Anfrage mitzusenden, damit Ihre Integration weiter funktioniert, wenn eine neue Version erscheint. Siehe [Versionen und Kompatibilität](https://docs.join.com/reference/versioning-and-depreciation).

**Beispielanfrage:**

```bash
curl -X GET \
  https://api.join.com/v3/jobs \
  -H 'Authorization: Bearer your-api-token-here' \
  -H 'Join-Version: 2026-11-01'
```

### API-Token widerrufen

Sie können ein Token jederzeit unter `Einstellungen` → `Entwickler` widerrufen. Beachten Sie dabei:

* Nach dem Widerruf funktioniert das Token sofort nicht mehr
* Tokens können nicht reaktiviert oder neu generiert werden
* Wenn ein Token widerrufen wurde, müssen Sie Ihre Integration mit einem neuen Token aktualisieren

***

## Rate Limits, Paginierung und Fehler

* **Rate Limits:** Jedes Token kann 600 Anfragen pro Minute senden, höchstens 100 innerhalb von 10 Sekunden. Darüber hinaus gibt die API `429 rate_limit_exceeded` mit einem `Retry-After`-Header zurück, der angibt, wann Sie es erneut versuchen können.
* **Paginierung:** Listen geben standardmäßig 10 Datensätze zurück, `limit` akzeptiert Werte von 1 bis 50. Für die nächste Seite senden Sie den `nextCursor` der Antwort als `cursor`. Auf der letzten Seite ist `nextCursor` gleich `null`.
* **Fehler:** Jeder Fehler hat das Format `{"error": {"code", "message", "details"}}`. `details` nennt die Felder, deren Validierung fehlgeschlagen ist.

Weitere Details finden Sie unter [Rate Limits](https://docs.join.com/reference/rate-limits), [Paginierung, Filterung und Sortierung](https://docs.join.com/reference/pagination) und [Antworten, Fehler und Wiederholungen](https://docs.join.com/reference/requests-and-responses).

***

## JOIN API v2

Die JOIN API v2 ist veraltet. Entwickeln Sie neue Integrationen auf v3 und planen Sie, bestehende v2-Integrationen auf v3 umzustellen.

* Bestehende v2-API-Schlüssel wurden automatisch zu Unternehmens-Tokens migriert. Ihre Werte haben sich nicht geändert, sodass Ihre v2-Integrationen weiter funktionieren. Sie finden sie unter `Einstellungen` → `Entwickler`, benannt nach dem Admin, dem der Schlüssel gehörte.
* Neue Tokens, die Sie unter `Entwickler` erstellen, funktionieren auch mit v2.

Wie Sie eine Integration von v2 auf v3 umstellen, erfahren Sie unter [Von v2 zu v3 wechseln](https://docs.join.com/reference/migration-guide-from-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://help.join.com/help-center/de/integrations-and-api/api-documentation.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.
