Skip to main content

​
Overview

All Forerunner API requests require authentication using Bearer tokens passed in the Authorization header. This ensures secure access to your organization’s data and maintains audit trails for API activity.

​
Getting your API key

API keys are provided by Forerunner and are organization-specific. To obtain an API key:
1

Contact your Customer Success Manager

Reach out to your Customer Success Manager to request API access.
2

Or email our team

Send a request to engineering@withforerunner.com with your organization name and use case.
3

Receive your API key

You’ll receive a long-lived API key that can be used for all API requests.

​
Using your API key

Include your API key in the Authorization header of every request:
cURL

​
API key lifecycle

API keys are long-lived but may be rotated for security reasons. Always store API keys securely and be prepared to update your integration if notified of an API key rotation.

​
API key security best practices

  • Never commit API keys to version control
  • Use environment variables or secure secret management systems
  • Rotate API keys periodically as a security best practice
  • Only share API keys with authorized team members
  • Use separate API keys for different environments when possible
  • Monitor API usage for unexpected patterns
  • Implement proper error handling for 401 Unauthorized responses
  • Log authentication failures for security monitoring
  • Have a process to quickly rotate compromised API keys

​
Authentication errors

​
Testing your authentication

Use this simple request to verify your API key is working:
A successful response indicates your authentication is configured correctly.