What is it about?
With the Frontend API v3, you can display softgarden job postings on your career site and collect applications digitally—all while maintaining your own look and feel.
1) What is the Frontend API v3?
The Frontend API v3 is an interface provided by softgarden that delivers detailed job information. It allows you to:
Display job lists
Retrieve job details
Create and submit applications
It is designed to connect your own career site with softgarden without requiring users to leave your site.
What the Frontend API v3 is not intended for:
Processing applications
Exporting applicant data
Deep system integration
The API serves as the "public gateway" to the application process.
2) What can you do with it?
Display jobs: Custom job list/search on your website with filtering and sorting functions (e.g., location, department).
Show job details: Display the title, description, and application link in your own design.
Embed application form: Candidates enter their details (basic info, questions, attachments) without leaving your site.
File uploads: Upload CVs, certificates, or profile pictures.
Self-service for applicants (optional): Create an applicant account and manage applications.
Result: A seamless, on-brand process with fewer drop-offs and a clearer candidate experience.
3) When is the Frontend API v3 the right choice?
You want full control over the UX and design of your career site.
Your IT team or web agency is capable of implementing simple API calls.
You want to offer a seamless candidate experience on your own website—without redirecting users to softgarden.
It is not ideal if you lack development resources; in that case, embeds (direct links to softgarden) or widgets (iFrames) are often quicker to implement.
4) Creating a Client ID to call API v3
To access API v3, you or your agency must first create a Client ID.
To do this, go to the following section in softgarden: "Settings" -> "Additional features" -> "Integrations"
Under the "softgarden API" section, you can assign a name for the Client ID and click "Create".
The value in the "ClientID" column can be used to call API v3.
Note: Only a public Client ID is required to use API v3. A secret is not needed.
5) How an API-based application works (simplified)
Retrieve job feed: Determine which jobs to display.
Load & display jobs: Present the list and detail pages on your website.
Create applicant account (or use an existing one): An account is required to apply. The account can be created as visible (self-service) or "implicit" (using a placeholder password).
Start application: A "draft application" is generated.
Save data and attachments: Upload form field entries, answers to mandatory questions, and documents.
Submit final application: The draft is finalized and becomes visible in the ATS.
Important: From the "Start application" step onwards, the API operates within the applicant's context. This protects the process and the data.
6) What do HR/IT need for this?
Design/UX decisions: Determine which fields, languages, and mandatory questions to display.
Technical resources: A web agency or in-house developers capable of rendering API responses and integrating forms.
Legal/Data protection: Provide privacy notices and consent texts.
File rules: Define maximum sizes and file types (recommendation: PDF/DOCX, ≤ 10 MB; 3–5 attachments are usually sufficient).
7) Frequently Asked Questions (FAQ)
Q: Do candidates apply multiple times using the same email address? A: There is one applicant account per email address. If an account already exists, the person must log in (a password reset option is available). Implicit account creation only works if an account does not yet exist.
Q: Do I need to store sensitive data myself? A: No. The website displays forms but does not permanently store the data—it is transmitted directly to softgarden.
Q: How do I include mandatory questions? A: The questions are provided on a per-job basis and displayed in the form (as mandatory or optional).