If you use Get on Board as a company or recruiting team and need your tools to exchange information automatically, the API lets your systems read and update Get on Board data without manual copy-paste. It is useful for recruiters, HR operations teams, ATS administrators, data teams, and developers who support recruiting workflows.
In practical terms, an API is a secure way for two systems to talk to each other. Instead of downloading a spreadsheet, forwarding an email, or re-entering the same candidate in another tool, your team can connect Get on Board with the software you already use.
Common ways to use the API
For recruiting teams using another ATS
If your team already works in an ATS or internal HR system, the API can help you keep Get on Board connected to that system.
You can:
- Import or update jobs from your ATS.
- Send applications from Get on Board to your ATS.
- Keep job and candidate information aligned between systems.
- Avoid asking recruiters to enter the same information twice.
Get on Board also has ready-made integrations with Lever, Greenhouse, and Ashby. If you use a different ATS, the API is the option for building a custom connection.
For HR operations and automation teams
The API can support internal workflows around job posting, candidate movement, and reporting.
You can:
- Create, update, publish, unpublish, or close jobs from another system.
- Retrieve applications and candidate information your company is allowed to access.
- See your hiring processes and stages so another tool can mirror your pipeline.
- Trigger internal notifications or workflows when applications arrive.
- Use webhooks when you need Get on Board to notify your system automatically about events.
For data, analytics, and market research teams
The public API can be used to study visible job-market information without logging in.
You can:
- Search published jobs.
- Review public company profiles and their published jobs.
- Consult categories, technologies, seniority levels, locations, perks, and other reference data.
- Use public insights about salaries, technologies, remote work, perks, and market trends.
For product teams, agencies, or custom career sites
If you are building a custom experience around Get on Board data, the API can feed that experience.
You can:
- Display published jobs on another site.
- Build a custom job search or job board using public listings.
- Create a custom application or recruiting interface for your team.
- Connect Get on Board with business intelligence, CRM, or workflow tools.
Public and private access
The public API does not require setup. It includes information that is already visible publicly on Get on Board, such as published jobs, companies, job categories, technologies, locations, and market insights.
The private API requires an API key and is for company data. It can include your jobs, applications, hiring processes, candidate information your company can access, webhook settings, and other recruiting data tied to your account. Private API access is available on Recruiter and higher subscription plans.
What the API is not for
The API is not a replacement for Get on Board’s recruiter interface. Your team can still manage jobs, review candidates, message professionals, and configure processes directly in Get on Board.
Some actions may still need to happen in the web interface, and access to candidate data depends on your account permissions, subscription status, and the information your company is allowed to view.
How to get started
If you only need public information, review the technical API documentation and start with the public endpoints.
If you need private company data, your company needs a plan with API access. Then open your company API settings, generate an API key, and share the technical documentation with the developer or vendor building the integration.
If you want to test private API access before subscribing, see How can I test Get on Board’s API before purchasing a plan?.
More from Integrations and developer tools
