Skip to main content

Apply API

This help article covers the Apply API, which allows external partners—such as job boards—to feed applications directly into your softgarden BMS in a structured format.

Important: The Apply API is not intended for BMS customers, but for third-party partners (e.g., job boards). Through this interface, partners can submit applications directly into your softgarden BMS as part of your partnership.

Summary

A partner (e.g., a job board) transmits validated application data to softgarden via the Apply API. The application lands directly in your applicant management system.

1) What is the Apply API?

The Apply API is an interface that allows external partners to submit applications to softgarden in a structured format. It is designed to enable services like job boards to deliver applications directly to your BMS.

What the Apply API is *not* intended for:

  • Building custom career sites

  • Displaying custom forms

The Frontend API v3 is designed for those purposes. The Apply API serves solely as an inbound channel for partners.

2) Benefits for HR

  • Reduced manual effort: No need to manually enter data from emails with attachments or handle import files.

  • Faster processing: Applications appear immediately within the correct job or workflow.

  • Better data quality: Mandatory fields and data structures arrive in a clean, standardized format.

  • Accurate source tracking: The origin (e.g., Job Board X) is documented.

3) Who is the Apply API for?

  • For partners (job boards, third-party providers) who want to submit applications directly into softgarden.

  • Not suitable for proprietary company career sites or DIY websites—the Frontend API v3 is designed for those use cases.

4) Process

  1. The partner collects the application (via their platform or a form).

  2. The partner validates the data and transmits it to softgarden via the Apply API (including job reference, contact details, and CV/attachments).

  3. softgarden creates the application—the record appears under the relevant job in your BMS.

  4. You continue working as usual (reviewing, categorizing, communicating, reporting).

5) Roles & Responsibilities

  • Partner: Obtains consent, collects the data correctly, and transmits it to softgarden.

  • softgarden: Receives the application, assigns it to the job, and makes it available within the process.

  • HR (you): Process the application in the ATS—no additional tools required.

6) Data Protection & Consent

  • The partner must ensure the legal basis or obtain the necessary consent for transferring application data to softgarden.

  • Within softgarden, data is processed for a specific purpose (the application process) in accordance with your data retention and deletion policies.

  • Source information assists you with transparency and data access requests.

7) Frequently Asked Questions (FAQ)

Q: Can we use the Apply API ourselves? A: No. It is intended exclusively for third-party partners. For your own sites or forms, use the Frontend API v3.

Q: How are attachments (CVs, certificates) handled? A: The partner submits the files along with the application; they appear in the application as usual.

Q: How is the source recorded? A: The partner transmits an identifier (e.g., job board or partner name) so that you can analyze the origin later.

Related Articles
Did this answer your question?