## Why It Matters

Most companies want job listings on their own website rather than sending candidates to a separate URL. Kit's embed mode lets you add your career portal to any page as an iframe — keeping candidates on your site while Kit handles the application flow.

## Embedding with an Iframe

Add your career portal to any webpage using an iframe. The basic embed code is:

```html
<iframe
  src="https://startupkit.app/careers/your-subdomain?embed=true"
  width="100%"
  height="800"
  frameborder="0"
  style="border: none;"
></iframe>
```

The `?embed=true` parameter activates embed mode, which:

- Removes the portal header and navigation
- Uses a compact layout optimized for iframes
- Sends height updates to the parent window via `postMessage` (for auto-resizing)
- Removes `X-Frame-Options` headers so the iframe loads correctly

## Customization Parameters

Append query parameters to the embed URL to customize the appearance:

| Parameter | Values | Description |
|-----------|--------|-------------|
| `embed` | `true` | Activates embed mode (required) |
| `theme` | `light`, `dark` | Override the portal's default theme |
| `bg` | Hex color (e.g. `%23ffffff`) | Set a custom background color to match your site |

**Example** with a dark theme and custom background:

```html
<iframe
  src="https://startupkit.app/careers/your-subdomain?embed=true&theme=dark&bg=%231a1a2e"
  width="100%"
  height="800"
  frameborder="0"
></iframe>
```

Note: Use `%23` instead of `#` for hex colors in URLs.

## Auto-Resizing

Kit sends the portal's content height to the parent window via `postMessage`. Add this script to your page to auto-resize the iframe:

```html
<script>
  window.addEventListener("message", function(event) {
    if (event.data && event.data.type === "resize") {
      var iframe = document.querySelector("iframe");
      iframe.style.height = event.data.height + "px";
    }
  });
</script>
```

This prevents scrollbars inside the iframe and gives candidates a seamless browsing experience.

## JSON API

Kit also provides a JSON API for your career portal if you want to build a completely custom job listing page. Request the career portal URL with an `Accept: application/json` header or append `.json`:

```
GET https://startupkit.app/careers/your-subdomain.json
```

The response includes all published job postings with their metadata (title, location, department, salary, etc.). The JSON response is cached for 5 minutes.

Use this when you need full control over the design and want to render job listings with your own frontend code. Each job in the response includes a `url` field that links to the public job detail page where candidates can apply.

## LLM-Readable Format (llms.txt)

Kit serves an `llms.txt` file for your career portal — a single markdown document that AI assistants and LLMs can consume to understand all your open positions at once:

```
https://startupkit.app/careers/your-subdomain/llms.txt
```

The file includes every published job posting with its full description, location, employment type, salary range, apply URL, and hiring process stages. When no positions are open, it directs to your talent pool.

This follows the [llms.txt specification](https://llmstxt.org) and is automatically linked in the career portal's HTML `<head>` for discovery. No configuration needed — it's always available and stays in sync with your published postings.

## SEO and Sitemap

Your career portal sitemap is available at:

```
https://startupkit.app/careers/your-subdomain/sitemap.xml
```

Kit automatically handles structured data, sitemaps, and real-time Google indexing for all published jobs. See [Google Jobs and SEO](/docs/google-jobs-and-seo) for full details on how your jobs appear in Google search results.

## Quick Checklist

- [ ] Add the iframe embed code to your company website
- [ ] Set `embed=true` to activate compact mode
- [ ] Match the theme and background color to your site's design
- [ ] Add the auto-resize script for seamless height adjustment
- [ ] Test the embed on both desktop and mobile
- [ ] Submit your career portal sitemap to Google Search Console
- [ ] Consider using the JSON API if you need a fully custom design