Skip to main content
All OutX API endpoints require authentication using an API key. This ensures secure access to your data and protects your account.

​
Getting Your API Key

To obtain your API key:
  1. Log in to your OutX account
  2. Visit mentions.outx.ai/api-doc
  3. Click “Reveal API Key” to view your key
  4. Copy and securely store your API key
OutX dashboard showing where to reveal and copy your API key
Keep your API key secure and never share it publicly. Treat it like a password.

​
Using Your API Key

Include your API key in the x-api-key header of every API request:

​
Header Format

x-api-key: YOUR_API_KEY

​
Example Request

curl -X GET \
  "https://api.outx.ai/api-keyword-watchlist" \
  -H "x-api-key: YOUR_API_KEY"

​
Chrome Extension Requirement

All API calls require that at least one team member has the OutX Chrome extension installed and active within the last 48 hours. This is because OutX retrieves LinkedIn data through the browser extension - it doesn’t use unofficial scraping or LinkedIn’s restricted API.
If no team member has an active extension, you’ll receive: 
{
  "error": "Plugin installation required: Please install the OutX browser extension on at least one team member's account to use the API. The plugin must have been active within the last 48 hours."
}
How to fix: Install the OutX Chrome Extension, sign into LinkedIn in the same browser, and keep the browser open. The extension needs to have been active within the last 48 hours. For more details, see Chrome Extension Guide.

​
Authentication Errors

​
401 Unauthorized

This error occurs when:
  • No API key is provided
  • The API key is invalid or expired
  • The API key format is incorrect
Response: 
{
  "error": "Unauthorized"
}
Solution: Verify that you’re including the correct API key in the x-api-key header.

​
403 Forbidden

This error occurs when:
  • You’re trying to access resources that don’t belong to your team
  • Your API key doesn’t have permission for the requested operation
Response: 
{
  "error": "Access denied: You don't have permission to access this resource"
}
Solution: Ensure you’re only accessing resources associated with your account.

​
Best Practices

  • Never commit API keys to version control
  • Use environment variables or secure key management systems
  • Rotate keys periodically for enhanced security
  • Always use HTTPS for API requests - Never send API keys over unencrypted connections
  • Track your API usage to stay within rate limits - Set up alerts for unusual activity - Review API logs regularly
  • Implement proper error handling in your code
  • Retry failed requests with exponential backoff
  • Log authentication errors for debugging

​
Rate Limiting

API rate limits are enforced per API key and vary based on your subscription plan:
  • Free Plan: 100 requests/hour
  • Pro Plan: 1,000 requests/hour
  • Enterprise Plan: Custom limits
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response: 
{
  "error": "Rate limit exceeded. Please try again later."
}
Need higher rate limits? Contact support@outx.ai to discuss enterprise options.

​
Team-Based Access

Your API key is associated with your team account. This means:
  • All API requests are scoped to your team’s data
  • You can only access watchlists and posts created by your team
  • Team members share the same rate limits

​
Next Steps

Quick Start Guide

Make your first API request

Watchlist APIs

Create and manage watchlists

​
Frequently Asked Questions

Q: Do all team members share the same API key? Yes. There is one API key per team. All team members use the same key, and all API requests are scoped to your team’s data. You can find your shared key at mentions.outx.ai/api-doc.
Q: Can I rotate or regenerate my API key? API key rotation is not currently available as a self-service feature. If you need to rotate your API key for security reasons, contact support@outx.ai and the team will generate a new key for you.
Q: Why am I getting a 403 error even though my API key is correct? The most common cause is the Chrome extension requirement. At least one team member must have the OutX Chrome extension installed and actively used within the last 48 hours. Without an active extension, all API calls will return a 403 error. Install the OutX Chrome Extension, sign into LinkedIn in the same browser, and keep the browser open.