A clean REST API, real-time webhooks, and typed SDKs for pipelines, compensation benchmarks, and workforce analytics. Everything our own platform runs on — available to you over a single, versioned interface.
From zero to a live response in under five minutes. Grab a key, install a client, and pull real data from your talent pipelines.
Sign in to the employer portal and open Settings → Developers. Generate a secret key scoped to the resources you need — read-only for analytics dashboards, or read/write for pipeline automation. Keys are prefixed ck_live_ in production and ck_test_ in the sandbox.
Official clients are available for JavaScript/TypeScript, Python, Ruby, Go, and Java. Each is fully typed, auto-retries idempotent requests, and tracks the current API version. Prefer raw HTTP? Every endpoint works with plain curl.
List the active pipelines on your account. The response is paginated, cursor-based, and identical across every SDK and the raw API. From here you can drill into candidates, pull compensation benchmarks, or subscribe to webhook events.
Six sets of docs cover the full platform surface — from the first curl request to production-grade webhook infrastructure.
Full REST reference — authentication, every endpoint, pagination, rate limits, and structured error handling.
ExploreOfficial clients for JavaScript, Python, Ruby, Go, and Java — typed, versioned, and open source.
InstallSubscribe to real-time events — candidate stage changes, offers extended, and compensation updates.
ConfigureConnect Workday, Greenhouse, Lever, BambooHR, Slack, and more — most with no code required.
BrowseEvery API change, addition, and deprecation — dated, versioned, and backwards-compatible by policy.
What's newReal-time uptime for the API, dashboard, and data pipeline — with incident history and a 99.9% SLA.
View statusThe Crimson API is organized around a small set of predictable resources. Everything returns JSON, uses standard HTTP verbs, and shares consistent identifiers you can reference across endpoints.
A pipeline represents an active search — a role, its hiring stages, and the candidates moving through them. List them, create new ones, and track time-to-fill and stage conversion in real time. IDs look like pipe_8Kx....
Candidate records carry stage, source, and structured profile data — always privacy-scoped to your organization. Retrieve, filter by pipeline or stage, and remove records to honor deletion requests. IDs look like cand_3Qp....
Live salary and equity benchmarks by role, market, and level — refreshed weekly from millions of verified data points. Query percentiles (p25–p90), base, bonus, and equity splits for any supported role. Read-only.
Aggregate talent-supply and demand signals, funnel conversion, and forecast models. Pull supply indices for a role and market, or run our forecast model to project time-to-fill and candidate availability up to two quarters out.
Authenticate with a bearer token over TLS 1.3. Scope keys by permission, rotate them anytime, and monitor per-key usage from your dashboard. Never expose a secret key in client-side code — use a server-side proxy or our publishable keys for browser contexts.
Live keys are limited to 1,000 requests per minute per organization, burstable to 2,000. Every response includes X-RateLimit-Remaining and X-RateLimit-Reset headers. Exceeding the limit returns 429 Too Many Requests — back off using the Retry-After header. Need more? Enterprise plans lift limits and offer dedicated capacity.
The API is versioned by date, e.g. 2026-04-01. Pin a version with the Crimson-Version header or your SDK config. We never make breaking changes to a released version — additive changes ship continuously, and deprecations get a minimum 12-month notice via the changelog.
Sign in to the employer portal to generate keys, invite teammates, and start building — or talk to us about enterprise platform access.
Go to the portal