Authentication

The endpoints in this API reference require a live key.

curl "https://api.freshtalent.ai/v1/me" \
  -H "Authorization: Bearer ft_live_…"

X-Api-Key: ft_live_… is accepted as well. Send only one method; a nonempty X-Api-Key takes precedence if both headers are present.

Recruiter

You do not need a key to use Search, Companies, Lists, Targets, and Monitoring in the dashboard. Create a key only when someone on your team is connecting Claude, a script, or the ATS. Sidebar → API Keys (not inside Settings).

Create a key

Dashboard

Sidebar → API Keys. Plaintext is shown once, on create or rotate.

CI / servers

export FRESHTALENT_API_KEY=ft_live_…
export FRESHTALENT_API_URL=https://api.freshtalent.ai

FRESHTALENT_APP_URL (https://freshtalent.ai) is only for device login.

Scoping

Customer keys see only their own org. X-FreshTalent-Org-Id is ignored on those keys. The App’s platform key may impersonate a session org with X-FreshTalent-Org-Id.

Failures

Status	`error.type`	Meaning
`401`	`unauthorized`	Missing, malformed, or revoked key
`400`	`invalid_request`	Invalid organization context or request; framework validation can use a different shape
`402`	`payment_required`	Organization access is locked after its trial; subscribe or restore access

{
  "error": {
    "type": "unauthorized",
    "message": "valid API key required (Authorization: Bearer ft_live_…)"
  }
}

Never put keys in frontend bundles, mobile apps, or git. Rotate in the dashboard if one leaks.

GET /me reports plan and Target-slot usage (watch_slots). Index allows 100 unique profile unlocks per UTC day across the dashboard, API, and MCP. Browsing returns first-name previews with opaque IDs. Use GET /people/{id}?unlock=true (or MCP get with unlock: true) to reveal a profile. Repeat unlocks that day cost nothing; quota exhaustion returns HTTP 429. Current availability flags and filters are included in Index. Monitoring, change-history feeds, and alerts require Unlimited. Get account remains available to inspect access.allowed. See Errors for status-first handling and retry guidance.

Start here

The product

Connect

Reference

Recruiter

Create a key

Scoping

Failures

​Recruiter

​Create a key

​Scoping

​Failures

Recruiter

Create a key

Scoping

Failures