canonical: https://jentic.com/apis/recruiterflow.com/recruiterflow

# Recruiterflow API

Recruiterflow ATS/CRM API for managing candidates, clients, contacts, jobs, campaigns, and activities. The API exposes 19 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list candidates, get candidate. Covers 19 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- List candidates
- Get candidate
- Add candidate
- Update candidate
- Search candidates
- Move candidate to stage

## Use cases

### CRM Operations

Use the Recruiterflow API to perform crm operations programmatically. The API provides 19 endpoints covering core functionality including list candidates, get candidate, add candidate.

Example prompt: Call GET `/api/external/candidate/list` to list candidates

### Automated Activities Management

Automate activities operations by combining multiple Recruiterflow API endpoints. Agents can get candidate and then add candidate in a single workflow.

Example prompt: Call GET `/api/external/candidate/get` to get candidate, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Recruiterflow API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'list candidates', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/external/candidate/list` | List candidates |
| GET | `/api/external/candidate/get` | Get candidate |
| POST | `/api/external/candidate/add` | Add candidate |
| POST | `/api/external/candidate/update` | Update candidate |
| POST | `/api/external/candidate/search` | Search candidates |
| POST | `/api/external/candidate/add-to-job` | Add candidate to job |
| POST | `/api/external/candidate/move-to-stage` | Move candidate to stage |
| POST | `/api/external/candidate/disqualify` | Disqualify candidate |

## Key resources

- **Activities** — Operations related to Activities
- **Campaigns** — Operations related to Campaigns
- **Candidates** — Operations related to Candidates
- **Clients** — Operations related to Clients
- **Contacts** — Operations related to Contacts

## Why Jentic

- **Setup:** Wiring the Recruiterflow API by hand means learning its apiKey auth, pointing at the api.recruiterflow.com host, and handling its `/api/external` requests yourself. Through Jentic you install once, import the Recruiterflow API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Recruiterflow's candidate operations take their target in the request body rather than the URL path, so limit the agent to the operations it needs, such as listing or adding candidates. You choose that set, so state-changing operations like disqualifying a candidate or moving one to a stage are only included if you add them.
- **Credential handling:** Your Recruiterflow API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list candidates' or 'add a candidate to a job', and Jentic returns the matching Recruiterflow operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Recruiterflow API use?

The Recruiterflow API uses an API key passed in the `RF-Api-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list candidates with the Recruiterflow API?

Yes. Use the GET `/api/external/candidate/list` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Recruiterflow API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list candidates through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list candidates'. Jentic returns the matching Recruiterflow API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Recruiterflow API have?

The Recruiterflow API exposes 19 endpoints covering activities, campaigns, candidates operations.

### Can I limit what my agent is allowed to do with the Recruiterflow API?

Yes. Jentic One is self-hosted by you, so your own rules decide which Recruiterflow operations and credentials the agent can use. Because the candidate operations take their target in the request body rather than the URL path, you scope access by choosing the exact set of operations you import, such as listing or adding candidates. State-changing calls like disqualifying a candidate or moving one to a stage are only available to the agent if you deliberately include them.