> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Recruiterflow

> Integration details and setup guide for the Recruiterflow connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                      |
| ----------------------------------- | ---------------------------- |
| **Authentication**                  | API Key (Header: RF-Api-Key) |
| **Two-Way Sync**                    | No                           |
| **Events Supported**                | No                           |
| **Realtime**                        | Polling                      |
| **Supports Rate Limiting**          | Yes                          |
| **Authentication Scopes Supported** | N/A (API Key)                |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Recruiterflow**:

* **Users**
* **Candidates**
* **Jobs**
* **Locations**
* **Organizations**
* **Employments**
* **Candidate Activities**
* **Scorecards**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                     |
| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Yes. Recruiterflow offers a free trial for new users. [Start free trial](https://recruiterflow.com/signup) |
| **Requires paid sandbox?**                         | No. The trial account can be used for testing and development.                                             |
| **Requires partnership to obtain authentication?** | No, but you need to request API access from Recruiterflow Support.                                         |

***

### Authentication (API Key)

For customers who want to completely whitelabel their authentication experience, you can provide your own developer keys instead of using Alloy Automation's.

<steps>
  <step title="Create Recruiterflow Account">
    Sign up for a free trial at [https://recruiterflow.com](https://recruiterflow.com) or log in to your existing account
  </step>

  <step title="Request API Access">
    1. Contact Recruiterflow Support at [https://recruiterflow.com/support](https://recruiterflow.com/support)
    2. Request API access for your account
    3. Provide details about your integration use case
    4. Wait for approval (typically takes 1-2 business days)
  </step>

  <step title="Receive API Key">
    1. Once approved, Recruiterflow Support will provide you with an API key
    2. The API key will be specific to your account
    3. Store the key securely (it provides full access to your recruitment data)
  </step>

  <step title="Configure in Alloy Automation">
    1. In Alloy Automation, enter your Recruiterflow API key
    2. The key will be sent in the `RF-Api-Key` header for all API requests
    3. Test the connection to verify authentication
  </step>
</steps>

For API documentation, visit [Recruiterflow Support](https://recruiterflow.com/support).

***

## Use Cases

### 1) ATS data synchronization

Sync candidate, job, and activity data from Recruiterflow to your internal systems or data warehouse to maintain a unified view of your recruitment pipeline.

### 2) Candidate sourcing automation

Automatically import candidates from external sources into Recruiterflow, enriching profiles with data from other platforms and tools in your recruitment tech stack.

### 3) Recruitment analytics

Pull candidate pipeline data, stage movements, and activity metrics from Recruiterflow into your BI platform for advanced recruitment analytics and reporting.

### 4) HRIS integration

Sync successful candidate placements from Recruiterflow to your HRIS system to automatically create employee records when candidates are hired.

### 5) Multi-channel candidate engagement

Coordinate recruitment communications across email, SMS, and other channels by integrating Recruiterflow with your marketing automation or communication platforms.

***

## API Gotchas

* **API key request required:** Unlike many platforms, Recruiterflow does not offer self-service API key generation. You must contact support and request access, which can take 1-2 business days.

* **Pagination required:** List endpoints support pagination with `current_page` and `items_per_page` parameters. Always implement pagination to retrieve complete datasets for large candidate or job lists.

* **Rate limiting:** The API enforces rate limits to protect system performance. Implement proper retry logic with exponential backoff to handle 429 (Too Many Requests) responses.

* **Activity types:** Candidate activities have different types (notes, interviews, emails, etc.). Use the activity types endpoint to understand available activity categories before filtering or processing activity data.

* **Stage movements:** Candidate stage movements are tracked separately from general activities. Use the dedicated stage movements endpoint to get complete candidate journey information.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.