Developers

Add candidates to Tarkflo from your own systems

Already keep candidates in an ATS, a CRM or a spreadsheet? The Tarkflo API lets that system send CVs, check what Tarkflo read from them, and save the ones you want into a job's pipeline. The job's workflow takes it from there.

Create your keys in the dashboard, under Settings, API keys.

01POST/v1/candidates/extract
{ "status": "ok", "name": "Ananya Rao",
  "email": "ananya.rao@example.com",
  "cv_id": "cv_7Qm2xN4v…" }
02POST/v1/candidates/submit
{ "application_id": "66f2d4b8…",
  "name": "Ananya Rao",
  "external_id": "greenhouse-48213" }
Extract reads the CVs and saves nothing. Submit saves the candidates you kept. Illustrative: the names are made up.

Two calls, with a review in between

Reading a CV is a best guess, and saving a candidate is a commitment. So they are two separate calls, and nothing reaches the pipeline until you say so.

01

Extract

Send the CVs for a job. Tarkflo reads the name, email and phone from each file and sends them back, along with any existing candidate who matches. Nothing is saved, no candidate is created and no email goes out.

02

Submit

Send the details you reviewed. Each candidate enters the job's pipeline with their CV attached, and the job's workflow starts. Tag each one with your own ID so results map back to your records, and send an idempotency key so a retry never adds anyone twice.

The API operates the pipeline. It does not configure it.

Workflows, interview templates and scoring rubrics are sets of linked settings. One API call cannot show you the checks the dashboard applies, so the API refers to them by ID and never edits them.

With the API

  • List the jobs a key can see
  • Read name, email and phone out of CVs
  • Submit candidates into a job's pipeline
  • Carry your own ID and metadata through to the result

In the Tarkflo dashboard

  • Create and edit jobs
  • Build workflows, interview templates and scoring rubrics
  • Run, watch and review interviews
  • Billing, members, single sign-on and API keys

Interviews run through the candidate's own link, in their own browser. The API cannot start one on their behalf.

Access is yours to manage.

Create API users and keys yourself in the Tarkflo dashboard. Nothing to request, and nothing to wait for.

How access works

  • One API user per integration, each with its own keys, so you can tell which system did what
  • A key is shown once, when you create it, and you can revoke it at any time
  • Scopes limit each key: read jobs, add candidates, or both
  • Every call lands in your audit log with the API user and key name
  • Owners have access by default and can grant it to a role

Start with the product. Add the API when you need it.

Let candidates move when they're ready, and let Tarkflo handle the work between application and decision. Start with your next role and see how much of the process it can take off your plate.

No credit card required · Start in minutes