Important: The Assessment API is not intended for BMS customers. It is designed for third-party assessment providers (e.g., testing or diagnostic tools) wishing to integrate their systems with softgarden. If you are interested in joining our marketplace, please visit: https://softgarden.com/de/partnerprogramme.
The Assessment API connects softgarden with external providers. This allows you, for example, to select tests directly within softgarden, invite candidates, and receive structured results—all without any break in the workflow.
1) What is the Assessment API?
The Assessment API is an interface between the softgarden ATS and an external assessment tool. The assessment provider provides its endpoints; softgarden calls this to retrieve tests, invite candidates, receive results and – if necessary – have data deleted.
What the Assessment API is not intended for:
Your own career pages or application forms (there is the Frontend API v3 for this)
Data exports from the back office
2) Who is the Assessment API worthwhile for?
For assessment providers/third-party providers who want to make their tool available in the softgarden ecosystem.
Not suitable if you just want to display jobs or collect applications - the frontend API v3 is intended for this.
3) How does an assessment via the API work? (simplified)
Retrieve tests: softgarden queries the provider to see which tests are available.
Trigger invitation: You select a test in softgarden; the provider receives the invitation, including candidate details.
Report update: Once the assessment is complete, the provider notifies softgarden of the update.
Retrieve results: softgarden fetches the results from the provider and displays them within the application.
Data deletion (optional): If required, softgarden initiates the deletion of data at the provider's end.
4) Roles & Responsibilities
Assessment provider: Provides the necessary endpoints and documents authentication and data formats.
softgarden: Integrates the endpoints, displays tests/results in the ATS, and manages the workflow.
HR team (you): Selects tests, triggers invitations, and uses the results in the selection process—without needing additional portals.
5) Security & Data Protection (explained simply)
Access is secured (authenticated API calls between softgarden and the provider).
Data minimization: Only the information necessary for the assessment is transmitted.
Results at a glance: Scores/ratings are stored centrally within the application record—traceable and audit-proof.
6) Frequently Asked Questions (FAQ)
Q: Can I use the assessment API myself as a customer? A: No. The API is designed for third-party providers. As a company, you use the ready-made integration directly within softgarden.
Q: Do candidates need to create a separate account with the provider? A: Generally, no—the invitation comes from softgarden, while the test runs on the provider's platform. The process is designed to be as seamless as possible for candidates.
Q: Where can I see the results? A: Directly within the application in softgarden—displayed as a score or status, and potentially with a link to a detailed report, depending on the provider.
Q: We already have a test provider—how do we get started? A: Please direct your provider to the softgarden Assessment API. They provide the endpoints, and we coordinate the connection together. To explore integration options, the provider can contact https://softgarden.com/de/partnerprogramme directly.