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.

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.