Embedding Your Career Portal
How to embed your career portal on your company website using an iframe, including customization options and API access.
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:
<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-Optionsheaders 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:
<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:
<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.
SEO and Sitemap
Kit generates a sitemap for your career portal at:
https://startupkit.app/careers/your-subdomain/sitemap.xml
The sitemap includes all published job postings with their last-updated timestamps. Submit this to search engines to improve the discoverability of your job listings. Kit also generates structured data (JSON-LD in the JobPosting schema) on each job detail page for rich search results.
Quick Checklist
- Add the iframe embed code to your company website
- Set
embed=trueto 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