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

# Documentation de l’API

Créez un jeton d’API JOIN, authentifiez vos requêtes à l’API JOIN v3 et découvrez le fonctionnement des versions, des limites de débit, de la pagination et des erreurs.

{% hint style="info" %}
**Qui peut l’utiliser**

* **Abonnements :** Advanced et Enterprise
* **Rôles :** Administrateurs système
  {% endhint %}

## Bien démarrer

Cette référence vous aide à prendre en main l’API JOIN v3, l’API REST de JOIN. L’API vous permet d’interagir avec vos données JOIN par programmation, par exemple pour récupérer des offres d’emploi, des candidatures ou gérer des fiches candidats.

L’API JOIN est sans état : chaque requête doit inclure une authentification et ne dépend d’aucune interaction précédente. Pour utiliser l’API, vous devez créer un jeton d’API dans JOIN.

Toutes les requêtes v3 sont envoyées à `https://api.join.com/v3`.

<a href="https://docs.join.com/reference/getting-started" class="button primary">Lire la documentation complète de l’API</a>

***

## Authentification

Pour valider vos requêtes, JOIN exige un jeton d’API. Le jeton appartient à votre entreprise, et non à un utilisateur en particulier. Il donne accès uniquement aux données de votre entreprise dans JOIN.

L’accès à l’API JOIN, y compris les identifiants d’API et la création de jetons, est réservé aux abonnements `Advanced` et `Enterprise`.

{% hint style="info" %}
Vous ne voyez pas la page `Développeur` ? Seuls les Administrateurs système peuvent l’ouvrir. Si `Créer un jeton` ouvre une invitation à changer d’abonnement, vérifiez votre abonnement : cliquez sur votre nom en bas à gauche, sélectionnez `Paramètres`, puis `Facturation`. Passez à l’abonnement `Advanced` ou `Enterprise` pour utiliser l’API JOIN et créer des identifiants.

Consultez [Abonnements](https://help.join.com/help-center/fr/plans-and-billing/subscription-plans.md) pour le détail des abonnements et les possibilités de mise à niveau.
{% endhint %}

### Créer un jeton d’API

1. Cliquez sur votre nom en bas à gauche et sélectionnez `Paramètres`.
2. Sélectionnez `Développeur`.
3. Cliquez sur `Créer un jeton`, saisissez un nom et copiez le jeton dans la fenêtre qui s’ouvre. Il ne s’affiche qu’une seule fois.

Votre entreprise peut avoir jusqu’à 10 jetons actifs.

{% hint style="warning" %}
Conservez votre jeton d’API en lieu sûr. Il donne accès aux données de votre entreprise dans JOIN, y compris la possibilité de lire, modifier ou supprimer des informations.
{% endhint %}

### Utiliser le jeton d’API

Envoyez votre jeton dans l’en-tête `Authorization` de chaque requête, sous forme de jeton Bearer : `Authorization: Bearer join_sk_…`. Les nouveaux jetons commencent par `join_sk_`.

Une requête sans jeton renvoie `401 authentication_required`. Un jeton invalide ou révoqué, ou utilisé avec un abonnement sans accès à l’API, renvoie `401 token_invalid`.

### Choisir une version de l’API

L’API JOIN v3 est versionnée par date. Envoyez l’en-tête `Join-Version` pour choisir une version. Sans cet en-tête, JOIN utilise `2026-11-01`. Une version inconnue renvoie `400 unsupported_api_version`.

Nous vous recommandons d’envoyer `Join-Version` avec chaque requête, afin que votre intégration continue de fonctionner à la sortie d’une nouvelle version. Voir [Versions and compatibility](https://docs.join.com/reference/versioning-and-depreciation) (en anglais).

**Exemple de requête :**

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

### Révoquer un jeton d’API

Vous pouvez révoquer un jeton à tout moment dans `Paramètres` > `Développeur`. Gardez à l’esprit que :

* Une fois révoqué, le jeton cesse immédiatement de fonctionner
* Les jetons ne peuvent pas être réactivés ni régénérés
* Si un jeton est révoqué, vous devez mettre à jour votre intégration avec un nouveau jeton

***

## Limites de débit, pagination et erreurs

* **Limites de débit :** chaque jeton peut envoyer 600 requêtes par minute, et au maximum 100 sur 10 secondes. Au-delà, l’API renvoie `429 rate_limit_exceeded` avec un en-tête `Retry-After` qui indique quand réessayer.
* **Pagination :** les listes renvoient 10 enregistrements par défaut, et `limit` accepte une valeur de 1 à 50. Pour obtenir la page suivante, envoyez le `nextCursor` de la réponse comme `cursor`. Sur la dernière page, `nextCursor` vaut `null`.
* **Erreurs :** chaque erreur est renvoyée sous la forme `{"error": {"code", "message", "details"}}`. `details` indique les champs dont la validation a échoué.

Pour en savoir plus, consultez [Rate limits](https://docs.join.com/reference/rate-limits), [Pagination, filtering and sorting](https://docs.join.com/reference/pagination) et [Responses, errors and retries](https://docs.join.com/reference/requests-and-responses) (en anglais).

***

## API JOIN v2

L’API JOIN v2 est obsolète. Créez vos nouvelles intégrations sur la v3 et prévoyez de migrer vos intégrations v2 existantes vers la v3.

* Les clés d’API v2 existantes ont été automatiquement migrées en jetons d’entreprise. Leurs valeurs n’ont pas changé : vos intégrations v2 continuent donc de fonctionner. Vous les trouverez dans `Paramètres` > `Développeur`, sous le nom de l’administrateur à qui appartenait la clé.
* Les nouveaux jetons que vous créez dans `Développeur` fonctionnent aussi avec la v2.

Pour migrer une intégration de la v2 vers la v3, consultez [Moving from v2 to v3](https://docs.join.com/reference/migration-guide-from-v2) (en anglais).


---

# 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/fr/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.
