> 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/nl/integrations-and-api/api-documentation.md).

# API-documentatie

Creëer een JOIN API token, authenticeer verzoeken aan de JOIN API v3 en leer hoe versies, tarieflimieten, paginatie en fouten werken.

{% hint style="info" %}
**Wie dit kan gebruiken**

* **Plannen:** Advanced en Enterprise
* **Roles:** System Admins
  {% endhint %}

## Aan de slag

Deze referentie helpt je om te beginnen met de JOIN API v3, JOIN's REST API. De API stelt je in staat om te communiceren met je JOIN data programmamatisch, bijvoorbeeld om vacatures op te halen, sollicitaties op te halen of kandidaat records te beheren.

De JOIN API is staatloze, wat betekent dat elk verzoek moet authenticatie omvatten en niet afhankelijk is van eerdere interacties. API, moet je een API token in JOIN.

Alle v3 verzoeken gaan naar `https://api.join.com/v3`.

<a href="https://docs.join.com/reference/getting-started" class="button primary">Lees vol API documentatie</a>

***

## Authenticatie

Om je APIverzoeken te valideren, vereist JOIN een API token. Het token behoort aan je bedrijf, niet aan één gebruiker. Het geeft alleen toegang tot de gegevens van je bedrijf in JOIN.

JOIN API toegang, met inbegrip van API referenties en token generatie, is alleen beschikbaar op de `Advanced` en `Enterprise` plannen.

{% hint style="info" %}
Ik kan de `Developer` Alleen pagina? System Admins kan het openen. `Create token` opent een upgradeprompt, controleer je plan: klik op je naam in de linker onderhoek, selecteer `Instellingen`, dan selecteren `Billing`. Upgrade naar `Advanced` of `Enterprise` te gebruiken JOIN API en het genereren van referenties.

Zie [Abonnement plannen](/help-center/nl/plans-and-billing/subscription-plans.md) voor plan details en upgrade begeleiding.
{% endhint %}

### Een API token aanmaken

1. Klik op je naam in de linkerbenedenhoek en selecteer `Instellingen`.
2. Selecteren `Developer`.
3. Klik op `Create token`, voer een naam in en kopieer het token uit het venster dat opent. Het wordt slechts één keer getoond.

Je bedrijf kan maximaal 10 actieve tokens.

{% hint style="warning" %}
Houd je API token veilig. Het geeft toegang tot je bedrijfsgegevens in JOIN, inclusief de mogelijkheid om informatie te lezen, bijwerken of verwijderen.
{% endhint %}

### Gebruik de API token

Stuur je token in de `Authorization` header van elk verzoek, als een teken: `Authorization: Bearer join_sk_…`. Nieuwe tokens beginnen met `join_sk_`.

Een verzoek zonder token geeft `401 authentication_required` terug. Een teken dat ongeldig is of ingetrokken, of gebruikt wordt op een plan zonder API toegang, geeft `401 token_invalid` terug.

### Kies een API versie

De JOIN API v3 is versioned by date. Stuur de `Join-Version` header om een versie te kiezen. Zonder deze, JOIN gebruikt `2026-11-01`. Een onbekende versie geeft terug `400 unsupported_api_version`.

We raden aan om `Join-Version` op elk verzoek te sturen, zodat je integratie blijft werken wanneer een nieuwe versie wordt uitgebracht. Zie [Versions and compatibility](https://docs.join.com/reference/versioning-and-depreciation).

**Voorbeeld verzoek:**

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

### Een API token herroepen

Je kunt een token op elk moment in `Instellingen` → `Developer` herroepen. Onthoud dat:

* Eenmaal ingetrokken, stopt het token onmiddellijk met werken
* Tokens kunnen niet worden gereactiveerd of geregenereerd
* Je moet je integratie bijwerken met een nieuw token als er één wordt ingetrokken

***

## Begrips-, paginatie- en foutenpercentages

* **Rate limieten:** elke token kan 600 verzoeken per minuut versturen, en ten hoogste 100 in 10 seconden. Boven dat, de API geeft `429 rate_limit_exceeded` met een `Retry-After` header die zegt wanneer opnieuw te proberen.
* **Paginatie:** lijsten geven standaard 10 records terug, en `limit` accepteert 1 tot 50. Om de volgende pagina te krijgen, stuur het antwoord `nextCursor` als `cursor`. Op de laatste pagina, `nextCursor` is `null`.
* **Errors:** elke fout komt als `{"error": {"code", "message", "details"}}`. `details` noemt de velden die mislukt validatie.

Voor nadere bijzonderheden, zie [Percentagelimieten](https://docs.join.com/reference/rate-limits), [Paginatie, filteren en sorteren](https://docs.join.com/reference/pagination) en [Reacties, fouten en herhalingen](https://docs.join.com/reference/requests-and-responses).

***

## JOIN API v2

JOIN API v2 is verouderd. Bouw nieuwe integraties op v3, en plan om bestaande v2-integraties te verplaatsen naar v3.

* Bestaande v2 API sleutels werden automatisch naar bedrijfstekens gemigreerd. Hun waarden veranderden niet, dus je v2 integraties blijven werken. Je vindt ze in `Instellingen` → `Developer`, genoemd naar de beheerder die eigenaar was van de sleutel.
* Nieuwe tokens die je maakt in `Developer` werken ook op v2.

Om een integratie te verplaatsen van v2 naar v3, zie [Verhuizen van v2 naar v3](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/nl/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.
