Authentication

FullHunt uses API Key-based authentication to allow access to the API. You can sign up for a new FullHunt account to have an API key and will find it on your profile settings.

API Key Setup

1. Visit FullHunt.io profile settings
2. Copy your API key
3. Use the X-API-KEY header in all API requests

Authentication Test

To authenticate and verify your API key:

curl "https://fullhunt.io/api/v1/auth/status" \
  -H "X-API-KEY: xxxx-xxxx-xxxx-xxxxxx"

tip

Make sure to replace xxxx-xxxx-xxxx-xxxxxx with your actual API key.

Response Format

A successful authentication response looks like this:

{
  "message": "",
  "status": 200,
  "user": {
    "company": "ACME",
    "email": "john.smith@acme.com",
    "first_name": "John",
    "last_name": "Smith",
    "plan": "enterprise"
  },
  "user_credits": {
    "credits_usage": 1,
    "max_results_per_request": 300000,
    "remaining_credits": 2999,
    "total_credits_per_month": 3000
  }
}

Response Fields

Field	Description
status	HTTP status code
message	Response message (empty on success)
user	User information object
user_credits	Credit usage and limits

User Object

Field	Description
company	Company name
email	User email address
first_name	User's first name
last_name	User's last name
plan	Current subscription plan

User Credits Object

Field	Description
credits_usage	Credits used this month
max_results_per_request	Maximum results per API request
remaining_credits	Remaining credits for the month
total_credits_per_month	Total credits allocated per month

Error Handling

If authentication fails, you'll receive an error response with appropriate HTTP status codes:

• 401 Unauthorized: Invalid or missing API key
• 403 Forbidden: API key doesn't have required permissions
• 429 Too Many Requests: Rate limit exceeded