Skip to main content

API Keys

API keys provide programmatic access to FairTest data. Use them to integrate FairTest with your own systems, scripts, or third-party tools.

Access​

API key management is available to Owners and Admins only. Go to Setup > Integrations and find the API Keys section.

Creating an API Key​

  1. Click Create API Key
  2. Enter a Name for the key (e.g. "Payroll Sync", "Safety Dashboard")
  3. Select Permissions:
PermissionAccess
ReadRead employees, tests, selections, and setup data
WriteCreate and update employees and tests
SelectionsRun random selections
  1. Choose an Expiration:
    • Never
    • 30 days
    • 90 days
    • 1 year
  2. Click Create

The API key is shown once after creation. Copy it immediately — it will not be displayed again.

Managing API Keys​

The active keys table shows:

ColumnDescription
KeyKey name with prefix (e.g. ft_xxxx...)
ScopesGranted permissions
CreatedDate the key was created
Last UsedDate the key was last used for a request
ExpiresExpiration date, or Expired in red if past

Revoking a Key​

  1. Click Revoke next to the key
  2. Confirm the action

Revoking a key is permanent and cannot be undone. Revoked keys are shown struck through in the table. Any requests using a revoked key will be rejected immediately.

Using Your API Key​

Include the API key as a Bearer token in the Authorization header:

curl -X GET https://app.fairtest.com.au/api/employees \
  -H "Authorization: Bearer ft_your_api_key_here" \
  -H "Content-Type: application/json"

All API requests must be made over HTTPS.

API Documentation and Tools​

  • API Reference — full endpoint documentation is available at the FairTest API Reference
  • OpenAPI Spec — download the OpenAPI specification from the API reference page for use with code generators or API clients
  • Postman — to import into Postman:
    1. Download the OpenAPI spec from the API reference page
    2. In Postman, click Import
    3. Select the downloaded file
    4. Postman will generate a collection with all available endpoints

Related Articles: