Recruitee

Recruitee is a collaborative applicant tracking system (ATS) and recruitment platform that helps teams source, track, and hire candidates. The Recruitee API provides programmatic access to candidates, job offers, departments, locations, and related hiring data, enabling you to sync recruitment records with your other systems.

Power end-to-end data operations for your Recruitee API with Nexla. Our bi-directional Recruitee connector is purpose-built for Recruitee, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Recruitee or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Recruitee workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Recruitee credential, you need a personal API token and your company's API base URL. Recruitee uses API token authentication, with the token sent in the Authorization header as a bearer token on every request.

To obtain your Recruitee credentials, follow these steps:

1. Sign in to your Recruitee account.

2. Navigate to Settings > Apps and plugins > Personal API tokens.

3. Click + New token in the top-right corner to generate a personal API token.

4. Click Show token, then copy the token value and store it securely. Only you can view your tokens; even account administrators cannot see them, and the token does not expire unless you manually revoke it.

5. Locate your Company ID. You can find it on the Personal API tokens page, under Settings > Company Settings > General, or in your admin URL after company=.

6. Construct your API base URL using your Company ID. The Recruitee REST API base URL is https://api.recruitee.com, and requests are scoped to your company at https://api.recruitee.com/c/{company_id}.

Personal API tokens are generated per user and per company according to your user role. If you manage more than one company in Recruitee, each company requires its own token. For detailed information about API authentication and available endpoints, see the Recruitee API Documentation.

Authenticate

Credentials required

Authenticate to Recruitee.

Field	Required	Secret	Description
API Key	Yes	Yes	Recruitee personal API token used to authenticate requests.
Base URL	Yes	No	API base URL.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Recruitee personal API token in the API Key field. This token is sent in the Authorization header as a bearer token for all API requests and must be kept confidential.

4. Enter your company-scoped API base URL in the Base URL field, for example https://api.recruitee.com/c/{company_id}, replacing {company_id} with your Recruitee Company ID.

   If your personal API token is compromised, revoke it in your Recruitee settings under Apps and plugins > Personal API tokens and generate a new one. The token provides access to your Recruitee company data and should be treated as sensitive information.

   For detailed information about API authentication and available endpoints, see the Recruitee API Documentation.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Recruitee connector tile, then select the credential that will be used to connect to the Recruitee instance, and click Next; or, create a new Recruitee credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Recruitee endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Candidates

Retrieve candidates.

• This endpoint template retrieves the list of candidates from your Recruitee account. Use it when you need to access candidate records for analysis, reporting, or synchronization with other systems.

For detailed information about candidate fields and API response structures, see the Recruitee API Documentation.

[Rest API] Get Candidate

Retrieve a single candidate by ID.

• This endpoint template retrieves a single candidate record. Provide the candidate Id to identify the record to fetch.

For detailed information about candidate fields and API response structures, see the Recruitee API Documentation.

[Rest API] List Candidate Notes

Retrieve notes for a single candidate.

• This endpoint template retrieves the notes associated with a candidate. Provide the candidate Id to identify the record whose notes will be fetched.

For detailed information about candidate notes and API response structures, see the Recruitee API Documentation.

[Rest API] List Offers

Retrieve offers.

• This endpoint template retrieves the list of job offers and talent pools from your Recruitee account. Use it when you need to access offer records for analysis, reporting, or synchronization with other systems.

For detailed information about offer fields and API response structures, see the Recruitee API Documentation.

[Rest API] Get Offer

Retrieve a single job offer or talent pool by ID.

• This endpoint template retrieves a single offer record. Provide the offer Id to identify the record to fetch.

For detailed information about offer fields and API response structures, see the Recruitee API Documentation.

[Rest API] List Departments

Retrieve departments.

• This endpoint template retrieves the list of departments from your Recruitee account. Use it when you need to access department records for analysis, reporting, or synchronization with other systems.

For detailed information about department fields and API response structures, see the Recruitee API Documentation.

[Rest API] List Locations

Retrieve company office locations.

• This endpoint template retrieves the list of company office locations from your Recruitee account. Use it when you need to access location records for analysis, reporting, or synchronization with other systems.

For detailed information about location fields and API response structures, see the Recruitee API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Recruitee data sources can also be manually configured to ingest data from any valid Recruitee API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Recruitee data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Recruitee destination, and select the Send to Destination option from the menu. Select the Recruitee connector from the list of available destination connectors, then select the credential that will be used to connect to the Recruitee organization, and click Next; or, create a new Recruitee credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Recruitee endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Candidate

Manually add a candidate to your Recruitee account.

• This endpoint sends data as JSON in the request body to create a new candidate. Each record from your Nexset is sent as a separate API request. The request body must contain candidate data in the format required by the Recruitee API.

For detailed information about candidate creation, request body formats, and available candidate properties, see the Recruitee API Documentation.

[Rest API] Update Candidate

Update a candidate with the provided ID.

• This endpoint sends data as JSON in the request body to update an existing candidate. Provide the candidate Id to identify the record to update. Each record from your Nexset is sent as a separate API request.

For detailed information about candidate updates, request body formats, and available candidate properties, see the Recruitee API Documentation.

[Rest API] Delete Candidate

Permanently delete a candidate with the provided ID.

• This endpoint deletes an existing candidate. Provide the candidate Id to identify the record to delete. This action permanently removes the candidate from your Recruitee account.

Deletion is permanent and cannot be undone. For detailed information about candidate deletion, see the Recruitee API Documentation.

[Rest API] Create Offer

Create a company offer (job or talent pool) in Recruitee.

• This endpoint sends data as JSON in the request body to create a new job offer or talent pool. Each record from your Nexset is sent as a separate API request. The request body must contain offer data in the format required by the Recruitee API.

For detailed information about offer creation, request body formats, and available offer properties, see the Recruitee API Documentation.

[Rest API] Apply for Offer

Apply for a job offer, creating a candidate application for the specified offer.

• This endpoint sends data as JSON in the request body to create a candidate application for a specific offer. Provide the Offer Slug to identify the offer to apply for. Each record from your Nexset is sent as a separate API request.

For detailed information about applying for offers, request body formats, and available application properties, see the Recruitee API Documentation.

Manual configuration

Recruitee destinations can also be manually configured to send data to any valid Recruitee API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Recruitee APIs typically expect JSON format for write operations. For update or delete operations, include the ID of the object to be modified at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Recruitee endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Recruitee endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.