Important Note: The Open API is only available to users on the "Business" plan or higher. Alternatively, organizations with formal partnerships with Recruit CRM may also qualify to access the API. Additionally, only the Account Owner can manage API keys for added security.
What this feature does and when to use it?
The Recruit CRM API allows external systems and applications to securely interact with Recruit CRM data using standard HTTP methods such as GET, POST, and DELETE. Using an API token for authentication, you can connect Recruit CRM with third-party tools and custom applications.
You can use this feature when:
• You want to connect Recruit CRM with external tools, custom applications, or reporting dashboards
• You are a developer implementing secure API authentication and integration workflows
• You require API access to automate candidate creation, resume parsing, timesheet retrieval, or data synchronization
• You want to build custom workflows and integrations using Recruit CRM data
Our API Documentation is available live at https://docs.recruitcrm.io
Important note for the developer
While asking our API to GET/POST/DELETE the required data, one must not directly query the endpoint on the front end/webpage, as it exposes the API token. You would need to hide the Recruit CRM API token/Bearer token. This can be done by introducing a server in between or by making the API token abstract. Basically, the webpage on the front end would query a private server in between which would then query the Recruit CRM API.
This is the safest way of doing this, as it would then prevent exposing the Recruit CRM API token/key publicly.
Also, if you encounter an error while using the API key, please ensure that you are not on a Free Trial account and generating a new API key on your end, as this may otherwise result in a 401 Authorization error ( INSUFFICIENT_ACCESS - Please Upgrade Your Plan to “Business” or “Enterprise” to gain access to the Open API).
While API tokens are available across all plans for integration with Workflow Automation (accessible to all plans), access to our public API requires a Business plan or higher.
These restrictions are specifically designed to ensure that sensitive organizational data remains protected and API tokens are managed by trusted individuals. Recruit CRM prioritizes security by limiting API access to Account Owners, thereby maintaining data integrity.
API Access: Account Owner vs. Admin Roles
Even if you have an Admin role within Recruit CRM, you cannot generate or retrieve the API key unless you are also the Account Owner. This measure ensures enhanced security by limiting access to the most trusted individual in the organization. If you are an Admin user and need API access, you may:
Request that the Account Owner retrieve the API key on your behalf, or
Ask the Account Owner to create a custom role for you with the necessary permissions to access the API token.
How to Access Your API Token?
Here are the step-by-step instructions to enable and copy your API token as the Account Owner.
Navigate to Admin Settings.
Scroll down and click on API to open the API section.
Note: Only the Account Owner can access and manage this section to ensure compliance with security measures.
Turn the toggle to the ON position to enable the API token.
Copy the displayed API token. Store it securely in your integration tool, backend server configuration, or secret manager. Avoid saving it in plain text files or sharing it over unsecured channels.
Creating a candidate using the API endpoint
Creating a candidate using the API endpoint
You can use the 'Creates a new candidate' endpoint to create a new candidate:
Retrieve Call Transcripts via API
Retrieve Call Transcripts via API
You can also retrieve generated call transcripts via the API.
In the Find Call Log via API endpoint, you can use the boolean query parameter: transcript_required.
When transcript_required is set to true, you can retrieve:
The full call transcript text.
Transcript segments with corresponding timestamps.
Parsing a resume using the API endpoint
Parsing a resume using the API endpoint
You can use the 'Resume Parser' API to upload a resume and automatically create or update a candidate in Recruit CRM. From the API Endpoints Documentation, select the Resume Parser endpoint, and upload the resume file in a supported format like PDF, DOC, DOCX, or RTF.
Once you send the request, the system will read the resume and extract basic details such as Candidate’s Name, Phone Number, Email, City, Full Address, Specialization, Work Experience Year, Work Experience Month, Current Organization, Title, Skills, Language Skills, Summary, Educational Qualification, Work and Education History and social medial URLs like Facebook URL, Twitter URL, LinkedIn URL, GitHub URL, Xing URL (if any).
Duplicate Handling
Duplicate handling is based on the “Allow Duplicate Candidates” setting in Admin Settings → Account Management.
If this setting is on, a new candidate is always created.
If this setting is off, the system checks for an existing candidate and updates the record based on the parsed resume data.
Overriding existing data
You can control how existing candidate data is updated using the override_data parameter.
If it is set to no, only empty or missing fields are filled, and existing data remains unchanged.
If it is set to yes, the existing candidate details are updated with the newly parsed information.
If duplicate candidates are allowed, this setting is ignored and a new candidate is created instead.
Note
Parsing custom fields is not supported.
Bulk parsing or parsing multiple resumes in a single call is not supported.
Count Candidates Matching Search Filters
Count Candidates Matching Search Filters
The API endpoint 'Count candidates matching search filters' returns the count of candidates matching a set of search filters - without exposing candidate profiles or resumes.
This is useful for building client-facing search experiences where you want to show how many matching candidates exist, without sharing candidate data itself.
Retrieving all timesheets using the API endpoint
Retrieving all timesheets using the API endpoint
You can retrieve a list of all timesheets from Recruit CRM using the 'Get All Timesheets' endpoint. This allows you to access the timesheet data, making it easier to integrate with external systems such as payroll or reporting tools.
Fetching timesheet details using the API endpoint
Fetching timesheet details using the API endpoint
You can fetch detailed information for a specific timesheet using the 'Get Timesheet by ID' endpoint.
This enables you to access complete timesheet records, including detailed timelogs.
Additionally, two response parameters, is_contractor and contractor_status, are available across the following six existing candidate endpoints:
Search for Candidates, Edit Candidate, Find Candidate by Slug, Get List of candidates which are marked as off limit, Show All Candidates, and Un-assign Candidate.
Troubleshooting
Problem: You cannot see the API section or API token in Admin Settings.
Problem: You cannot see the API section or API token in Admin Settings.
Likely cause: You are not logged in as the account owner.
What to check: Confirm your role (account owner vs admin vs other).
Resolution: Log in as the account owner, or ask the account owner to either retrieve the token for you or create a custom role that grants API token access.
FAQs
Who can manage and view the Recruit CRM API token?
Who can manage and view the Recruit CRM API token?
Only the account owner can manage and retrieve the API token by default. Admin users cannot access the token unless the account owner grants a custom role with explicit permission to access the API token.
Is the API available on all Recruit CRM plans?
Is the API available on all Recruit CRM plans?
No. The API is only available to users on the Business plan or higher. Organizations with a formal partnership with Recruit CRM may also qualify for API access.
Can I call the Recruit CRM API directly from my website or client-side application?
Can I call the Recruit CRM API directly from my website or client-side application?
No. You must not directly query the API endpoint from a front-end webpage or client-side application using the API token, because this exposes the token and can compromise your data security. Always use the API token on the server side.
Where can I find the official Recruit CRM API documentation?
Where can I find the official Recruit CRM API documentation?
The API documentation is available online at the Recruit CRM API documentation link: https://docs.recruitcrm.io
Conclusion:
Using the Recruit CRM API securely starts with ensuring only authorized users manage the API token and that it is never exposed in front-end environments. By following the role requirements, plan prerequisites, and security guidelines in this article, you can confidently enable integrations.
For the full list of available endpoints, request parameters, and response formats, visit the official API documentation at docs.recruitcrm.io.
If you need further help, use the chat icon at the bottom right of the screen to reach the support team.