API documentation

Whether you're building a custom integration or pulling data into your internal tools, this guide will give you the resources to get started with using JOIN's API.

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.

Read full API documentation

---

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.

JOIN API access, including API credentials and token generation, is available only on the Advanced and Enterprise plans.

Can't see API Credentials? Check your plan under Settings → Billing. Upgrade to Advanced or Enterprise to use JOIN API and generate credentials. See Subscription plans for plan details and upgrade guidance.

Generating an API token

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

Keep your API token secure. It provides access to your company data in JOIN, including the ability to read, update or delete information.

Using the API token

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

Example request:

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