Skip to main content
Version: 1.0.0

Tarkflo API

The Tarkflo API lets another system operate a hiring pipeline: find a job, read candidate details out of CVs, and submit reviewed candidates into that job.

It does not configure Tarkflo. Workflows, interview templates, rubrics and billing stay in the dashboard, and the API refers to them by ID.

Base URL: https://api.tarkflo.com/v1

Authentication: send your API key as a bearer token, or in an X-API-Key header. Each key acts as a user with the role you chose when you created it. See Authentication.

Conventions: resources have their own endpoints and are read with GET. Lists page with limit and a cursor. Field names are snake_case, times are ISO 8601 in UTC, and IDs are strings. Errors are RFC 9457 problem details (application/problem+json). Responses are private and not stored, except where an endpoint says they may be kept. See Errors and Rate limits.

Authentication​

An API key from Settings, API keys in Tarkflo, sent as Authorization: Bearer tf_live_.... See Authentication.

cURL

curl https://api.tarkflo.com/v1/jobs \
-H "Authorization: Bearer $TARKFLO_API_KEY"

Node.js

const headers = { Authorization: `Bearer ${process.env.TARKFLO_API_KEY}` };
const res = await fetch("https://api.tarkflo.com/v1/jobs", { headers });

Python

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['TARKFLO_API_KEY']}"}
res = requests.get("https://api.tarkflo.com/v1/jobs", headers=headers, timeout=30)

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

API key

Contact

Tarkflo developer support: developers@tarkflo.com