# API documentation

### Get started

This reference helps you implement the RESTful JOIN API v2. The API allows you to interact with your JOIN data programmatically – for example, to fetch job listings, retrieve applications, or manage candidate records.

The JOIN API is stateless, meaning each request must include authentication and does not rely on prior interactions. To use the API, you’ll need to generate an API token from your JOIN account.

<a href="https://docs.join.com/reference/getting-started" class="button primary">Read full API documentation</a>

***

### Authentication

To validate your API requests, JOIN requires an API token. This token identifies you and links actions performed via the API to your JOIN account.

#### Generating an API token

1. Go to `User Settings` in your JOIN account
2. Click `API Credentials`
3. Click `Generate new Token`

{% hint style="warning" %}
Keep your API token secure. It provides access to your company data in JOIN, including the ability to read, update or delete information.
{% endhint %}

#### Using the API token

You must include your token in the `Authorization` header of every API request.

**Example request:**

```bash
curl -X GET \
  https://api.join.com/v2/jobs \
  -H 'Authorization: your-api-token-here'
```

#### Revoking the API token

You can revoke a token at any time in the `API Credentials` section of your account. Keep in mind that:

* Once revoked, the token can no longer be used
* Tokens cannot be reactivated or regenerated
* You must update your integration with a new token if one is revoked


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.join.com/join-api/api-documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.