Skip to main content
The Platform API is for teams that recruit with the Kalent app and want to automate part of that work: create a sourcing from your ATS, push candidates into it, launch outreach sequences, and read their status back. Everything you create through this API shows up in the app, and everything your recruiters do in the app is visible through it.

​
What it covers

Sourcing

Create sourcing campaigns and list the ones your workspace owns.

Candidates

Add talents to a sourcing, read and update candidates, and enrich their contact details.

Sequences

Create outreach blueprints, start sequences for candidates, and follow their progress.

​
What it assumes

  • A workspace that your team uses in the Kalent app, with an active Kalent subscription. Sourcings, candidates, and sequences live in that workspace; routes such as create sourcing answer 402 plan_upgrade_required when the subscription does not include the capability.
  • An API key for that workspace; see Authentication.
  • Contact credits for candidate contact enrichment. This API does not spend API credits; talent search on the Embedded API does.

​
Same key, same credits as the Embedded API

The Embedded API covers talent search, qualified search, and LinkedIn contact enrichment without any dependency on the app. Both APIs authenticate with the same workspace API key. API credits and contact credits are separate workspace balances; see Credits. A common pattern is to find talents with the Embedded API, then add the ones you keep to a sourcing with the Platform API so your recruiters take over in the app.

​
Next steps

  1. Read Authentication and Non-deterministic results.
  2. Create a sourcing with POST /v1/sourcings, then add a talent with POST /v1/sourcings/{sourcingId}/candidates.
  3. Import the Postman collection: its Sourcing, Candidates, and Dynamic sequences folders follow the same order.