This reference helps you implement the RESTful JOIN API v1. The API is stateless – all requests are validated against an API token. The API token can be obtained manually from the JOIN app.

To validate your requests, you'll need your API token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen JOIN account.

Generating an API token

  • Navigate to the API Settings in your JOIN Account (User Settings > API Credentials)
  • Click on "Generate new Token"



Keep your API token secure, as it can be used to access, modify and delete your data in JOIN.

Using the API token

curl -X GET \ \
  -H 'Authorization: token'

Revoking the API token

You can revoke your API tokens at any time, but remember that integrations that use the token will no longer work after it has been revoked. As it is impossible to regenerate existing API tokens, you will need to create a new API token and update it in your integration.