Custom Connector
Indeed Connector
Global
The Indeed Connector provides access to job and company data — job details, job search, company details, company search, and a company’s job postings — via a RapidAPI-backed proxy. It’s ideal for careers pages, job boards, and recruitment dashboards.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Indeed Connector.
- getJobDetails. Retrieve details for a specific job.
- searchJobs. Search for jobs with multiple filters.
- getCompanyDetails. Retrieve details for a specific company.
- searchCompanies. Search for companies by name.
- getCompanyJobs. Retrieve job postings for a specific company.
Documentation
Detailed Integration Documentation
Job Details Retrieval
| Action | getJobDetails |
|---|---|
| Purpose | Retrieves detailed information for a specific job posting. |
| Configuration | Configure the connector with your API base URL and RapidAPI key. |
| Parameters | Required: job_id — the unique job ID (e.g. 12345); X-RapidAPI-Key. Optional: locality — locality filter. |
| Output | Successful: job details including title, company, location, description, and requirements. Failure: error details (e.g. unauthorized, invalid job ID). |
| Workflow example | Execute getJobDetails with job_id=12345, then display the job title, description, and employer. |
Job Search
| Action | searchJobs |
|---|---|
| Purpose | Searches for jobs using filters such as keywords, location, type, and date. |
| Configuration | Configure the connector with your API base URL and RapidAPI key. |
| Parameters | Required: X-RapidAPI-Key — your API key. Optional: query (e.g. Software Engineer); location (e.g. New York); page_id; locality; fromage (days since posting, e.g. 7); radius (miles); sort (e.g. date); job_type (e.g. permanent). |
| Output | Successful: a list of postings with job IDs, titles, company names, and summaries. Failure: error details (e.g. unauthorized, bad request). |
| Workflow example | Execute searchJobs with query=Software Engineer and location=New York, then present results in a search interface. |
Company Details Retrieval
| Action | getCompanyDetails |
|---|---|
| Purpose | Retrieves detailed information about a specific company. |
| Configuration | Configure the connector with your API base URL and RapidAPI key. |
| Parameters | Required: company — the company name or ID (e.g. Google); X-RapidAPI-Key. Optional: locality. |
| Output | Successful: company details including name, industry, ratings, and headquarters. Failure: error details (e.g. invalid key, company not found). |
| Workflow example | Execute getCompanyDetails with company=Google, then display the company profile. |
Company Search
| Action | searchCompanies |
|---|---|
| Purpose | Searches for companies by name. |
| Configuration | Configure the connector with your API base URL and RapidAPI key. |
| Parameters | Required: X-RapidAPI-Key — your API key. Optional: company_name (e.g. Amazon); locality. |
| Output | Successful: a list of companies matching the query with IDs and basic details. Failure: error details. |
| Workflow example | Execute searchCompanies with company_name=Amazon, then select the desired company ID for further queries. |
Company Jobs Retrieval
| Action | getCompanyJobs |
|---|---|
| Purpose | Retrieves job listings posted by a specific company. |
| Configuration | Configure the connector with your API base URL and RapidAPI key. |
| Parameters | Required: company — name or ID (e.g. Microsoft); X-RapidAPI-Key. Optional: locality; start — starting index for pagination. |
| Output | Successful: job postings related to the company. Failure: error details (e.g. unauthorized, bad request). |
| Workflow example | Execute getCompanyJobs with company=Microsoft, then populate a careers page or dashboard. |
Example Workflow: Job Search & Company Data
| Search jobs | Use searchJobs with query=Data Scientist and location=Berlin to display available postings. |
|---|---|
| Retrieve job details | Select a job and call getJobDetails with its job_id for the full description and requirements. |
| Retrieve company info | Use getCompanyDetails with the company ID from the job results. |
| Get company jobs | Call getCompanyJobs with the company name or ID to fetch all postings from that employer. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.