Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.hirebase.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Available Company Endpoints

Hirebase offers two main endpoints for accessing company data:
  1. POST /v2/hirebase/companies/search - Search for companies by various criteria
  2. GET /v2/hirebase/companies/:company_slug - Retrieve a record for a Company

​
Get Company

Retrieve a single company profile (plus a sample job listing) by its slug: 
const getCompanies = async (page = 1, limit = 10) => {
  const response = await fetch(`https://api.hirebase.org/v2/hirebase/companies/nextdoor`, {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'YOUR_API_KEY',
    },
  });
  
  const data = await response.json();
  return data;
};

​
Response Structure

{
    "company": {
        "company_slug": "nextdoor",
        "company_name": "Nextdoor",
        "company_logo": "https://recruiting.cdn.greenhouse.io/external_greenhouse_job_boards/logos/000/000/114/resized/Nextdoor_logo_badge-circle_RGB.png?1613705682",
        "job_board": null,
        "linkedin_link": "https://www.linkedin.com/company/nextdoor-com",
        "company_link": "about.nextdoor.com",
        "description_summary": "Nextdoor is a social platform connecting neighbors for community support and local engagement.",
        "size_range": null,
        "industries": [
            "Tech, Software & IT Services"
        ],
        "subindustries": [
            "Internet of Things (IoT)",
            "Digital Media & Entertainment"
        ]
    },
    "jobs": [
        {
			// 1 example Jobs Object from this company, or none if the company has no open jobs
        }
    ]
}

​
Get Company Jobs

The GET endpoint allows you to retrieve companies with basic pagination: 
const getCompanies = async (page = 1, limit = 10) => {
  const response = await fetch(`https://api.hirebase.org/v2/hirebase/companies/nextdoor/jobs?page=1&limit=10`, {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'YOUR_API_KEY',
    },
  });
  
  const data = await response.json();
  return data;
};

​
Response Structure

{
    "jobs": [
        // List of 10 Job Objects
    ],
    "job_categories": [ // Categories found that the company is hiring for
        {
            "category": "Engineering Jobs"
        },
        {
            "category": "Software Engineer Jobs"
        },
        {
            "category": "Product Jobs"
        }
    ],
    "total_count": 4,
    "page": 1,
    "limit": 10,
    "total_pages": 1
}

​
Searching Companies

The search endpoint provides more powerful filtering options: 
const searchCompanies = async () => {
  const response = await fetch('https://api.hirebase.org/v2/hirebase/companies/search', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      query: "Artificial Intelligence",
      geo_locations: {
        city: "San Francisco", 
        region: "CA", 
        country: "United States"
      },
      industries: ["Tech, Software & IT Services"],
      company_types: ["Startup"],
      page: 1,
      limit: 10
    }),
  });
  
  const data = await response.json();
  return data;
};

​
Search Parameters

  • geo_locations: Object with city, region, and country fields
  • industries: Array of industry categories
  • subindustries: Array of more specific industry categories
  • company_types: Types of companies (e.g., “Startup”, “Enterprise”)

​
Use Cases for Company Data

​
Finding Companies in a Specific Industry

const findAICompanies = async () => {
  const response = await fetch('https://api.hirebase.org/v2/hirebase/companies/search', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      industries: ["Tech, Software & IT Services"],
      subindustries: ["AI & ML"],
      limit: 20
    }),
  });
  
  const data = await response.json();
  return data;
};

​
Company Profile Enrichment

Once you have a company’s data, you can use it to enhance job listings or build company profiles in your application and search through their jobs.

​
Next Steps