API Reference

API key

Using your API Key to connect securely to FranchiseLab Recruiter's API

The API requires an API key with each request. A token can be generated from your FranchiseLab account.

To find your API Key, follow the steps below:

  1. Log in to FranchiseLab Recruiter as an Administrator user.
  2. Navigate to Settings by clicking the gear icon on the bottom left
  3. Navigate to API Settings on the left-hand navigation bar.
  4. Ensure 'Enable API' is toggled on.
  5. Copy the field labelled 'API Key'.

Once you've obtained an API Key, it needs to be passed in the api_key header on requests to the API. For example, api_key: eyJhbGciOiJIUzI1NiJ9.eyJ0aWQiOj....eh554fc

The API Key should be considered as a "personal access token" that you control yourself, for your own FranchiseLab Recruiter tenant.