SG Developers Applicant Data Export
General Purpose
The softgarden ATS allows to export Applicant base data and position data to 3rd party systems such as HR Suites. Next to the provided applicant data, the export can also include the applicant PDF – a system-generated summary pdf, including all attachments.
As soon as a candidate is moved to a certain status, e.g. “Onboarding” or “Hired”, the data is automatically transmitted via the interface.
Get started with the Candidate Export from the softgarden ATS
To begin the integration process in the softgarden ATS, please send the following information to support@softgarden.de:
- Status change in softgarden at which the export is to take place.
- URL of the API endpoint of the third party system that accepts the export [in case of PUSH]
- Authentication information required by the endpoint (such as username/password or token)
- Data format (JSON, XML) and structure that the endpoint expects.
- Any data fields that are required by the target system
Important: Data is only transferred from the point of setup. Applicants that were previously in a certain status are not considered in the interface.
There are two types of export supported by the system:
PUSH:
softgarden pushes the candidate data to the specified URL of the 3rd party. This export requires an interface to the partner system to which the data can be sent. The endpoint must be able to process data in JSON or XML formats.
PULL:
softgarden provides the data under an internal url where the 3rd party can pull from.
The target structure will be adapted here in consultation with the customer system.
Technical restriction: all data must be able to be transmitted in one request (incl. authentication).
Sample Export Pull
Contains an array of all applications that were not yet pulled. Note that the data field contains the JSON data as string and needs to be parsed again.
|
1 2 3 4 5 6 7 |
[ { "companyId": "ade3388d-3c7c-4c8d-807b-a09c090758c0", "applicationPublicId": "6b492a01-d21b-4e72-b4d0-51528a555d2b", "data": "{\r\n \"profile\": {\r\n \"APPLICANT_ID\": \"6b492a01-d21b-4e72-b4d0-51528a555d2b\",\r\n \"COMPANY_ID\": \"ade3388d-3c7c-4c8d-807b-a09c090758c0\",\r\n \"COMPANY\": \"Demo GmbH\",\r\n \"COMPANY_POSITION\": \"Product Manager (m/w/d)\",\r\n \"GENDER\": \"W\",\r\n \"TITLE_OF_NOBILITY\": \"Dr\",\r\n \"FIRST_NAME\": \"Max\",\r\n \"LAST_NAME\": \"Mustermann\",\r\n \"BIRTHDATE\": \"1990-01-01\",\r\n \"ADDRESS\": \"Tauentzienstraße 14\",\r\n \"ZIP\": \"10789\",\r\n \"CITY\": \"Berlin\",\r\n \"COUNTRY\": \"DE\",\r\n \"EMAIL_PRIVATE\": \"Max.Mustermann@.softgarden.de\",\r\n \"PHONE\": \"030123456789\",\r\n \"PHONE_MOBILE\": \"0171123456789\",\r\n \"NATIONALITY\": \"Deutsch\",\r\n \"LANGUAGES\":[\r\n {\r\n \"locale\": \"de\",\r\n \"skill\": \"1.0\"\r\n },\r\n {\r\n \"locale\": \"en\",\r\n \"skill\": \"3.0\"\r\n }\r\n ],\r\n \"EXPERIENCES\":[\r\n {\r\n \"job_title\": \"Product Manager\",\r\n \"company_name\": \"softgarden e-recruiting GmbH\",\r\n \"seniority\": \"Berufseinsteiger\",\r\n \"start_date\": \"2012-12-13\",\r\n \"end_date\": \"2014-01-01\"\r\n },\r\n {\r\n \"job_title\": \"Senior Product Manager\",\r\n \"company_name\": \"Unternehmensname\",\r\n \"seniority\": \"Mit Berufserfahrung\",\r\n \"start_date\": \"2014-01-01\",\r\n \"end_date\": \"\"\r\n }\r\n ],\r\n \"EDUCATIONS\":[\r\n {\r\n \"school\": \"School of Product Management\",\r\n \"spezialized_subject\": \"Product Management\",\r\n \"degree\": \"Bachelor\",\r\n \"start_date\": \"2000-12-16\",\r\n \"end_date\": \"2004-11-29\"\r\n },\r\n {\r\n \"school\": \"School of Product Management\",\r\n \"spezialized_subject\": \"Product Management\",\r\n \"degree\": \"Master\",\r\n \"start_date\": \"2006-12-16\",\r\n \"end_date\": \"2016-02-18\"\r\n }\r\n ],\r\n \"SUMMARY_PDF\": \"JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwogIC9QYWdlcyAyIDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwKICAvVHlwZSAvUGFnZXMKICAvTWVkaWFCb3ggWyAwIDAgMjAwIDIwMCBdCiAgL0NvdW50IDEKICAvS2lkcyBbIDMgMCBSIF0KPj4KZW5kb2JqCgozIDAgb2JqCjw8CiAgL1R5cGUgL1BhZ2UKICAvUGFyZW50IDIgMCBSCiAgL1Jlc291cmNlcyA8PAogICAgL0ZvbnQgPDwKICAgICAgL0YxIDQgMCBSIAogICAgPj4KICA+PgogIC9Db250ZW50cyA1IDAgUgo+PgplbmRvYmoKCjQgMCBvYmoKPDwKICAvVHlwZSAvRm9udAogIC9TdWJ0eXBlIC9UeXBlMQogIC9CYXNlRm9udCAvVGltZXMtUm9tYW4KPj4KZW5kb2JqCgo1IDAgb2JqICAlIHBhZ2UgY29udGVudAo8PAogIC9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCjcwIDUwIFRECi9GMSAxMiBUZgooSGVsbG8sIHdvcmxkISkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNzkgMDAwMDAgbiAKMDAwMDAwMDE3MyAwMDAwMCBuIAowMDAwMDAwMzAxIDAwMDAwIG4gCjAwMDAwMDAzODAgMDAwMDAgbiAKdHJhaWxlcgo8PAogIC9TaXplIDYKICAvUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKNDkyCiUlRU9G\"\r\n }\r\n}" } ] |
Sample Export Push
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
{ "profile": { "APPLICANT_ID": "6b492a01-d21b-4e72-b4d0-51528a555d2b", "COMPANY_ID": "ade3388d-3c7c-4c8d-807b-a09c090758c0", "COMPANY": "Demo GmbH", "COMPANY_POSITION": "Product Manager (m/w/d)", "GENDER": "W", "TITLE_OF_NOBILITY": "Dr", "FIRST_NAME": "Max", "LAST_NAME": "Mustermann", "BIRTHDATE": "1990-01-01", "ADDRESS": "Tauentzienstraße 14", "ZIP": "10789", "CITY": "Berlin", "COUNTRY": "DE", "EMAIL_PRIVATE": "Max.Mustermann@.softgarden.de", "PHONE": "030123456789", "PHONE_MOBILE": "0171123456789", "NATIONALITY": "Deutsch", "LANGUAGES":[ { "locale": "de", "skill": "1.0" }, { "locale": "en", "skill": "3.0" } ], "EXPERIENCES":[ { "job_title": "Product Manager", "company_name": "softgarden e-recruiting GmbH", "seniority": "Berufseinsteiger", "start_date": "2012-12-13", "end_date": "2014-01-01" }, { "job_title": "Senior Product Manager", "company_name": "Unternehmensname", "seniority": "Mit Berufserfahrung", "start_date": "2014-01-01", "end_date": "" } ], "EDUCATIONS":[ { "school": "School of Product Management", "spezialized_subject": "Product Management", "degree": "Bachelor", "start_date": "2000-12-16", "end_date": "2004-11-29" }, { "school": "School of Product Management", "spezialized_subject": "Product Management", "degree": "Master", "start_date": "2006-12-16", "end_date": "2016-02-18" } ], "SUMMARY_PDF": "JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwogIC9QYWdlcyAyIDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwKICAvVHlwZSAvUGFnZXMKICAvTWVkaWFCb3ggWyAwIDAgMjAwIDIwMCBdCiAgL0NvdW50IDEKICAvS2lkcyBbIDMgMCBSIF0KPj4KZW5kb2JqCgozIDAgb2JqCjw8CiAgL1R5cGUgL1BhZ2UKICAvUGFyZW50IDIgMCBSCiAgL1Jlc291cmNlcyA8PAogICAgL0ZvbnQgPDwKICAgICAgL0YxIDQgMCBSIAogICAgPj4KICA+PgogIC9Db250ZW50cyA1IDAgUgo+PgplbmRvYmoKCjQgMCBvYmoKPDwKICAvVHlwZSAvRm9udAogIC9TdWJ0eXBlIC9UeXBlMQogIC9CYXNlRm9udCAvVGltZXMtUm9tYW4KPj4KZW5kb2JqCgo1IDAgb2JqICAlIHBhZ2UgY29udGVudAo8PAogIC9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCjcwIDUwIFRECi9GMSAxMiBUZgooSGVsbG8sIHdvcmxkISkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNzkgMDAwMDAgbiAKMDAwMDAwMDE3MyAwMDAwMCBuIAowMDAwMDAwMzAxIDAwMDAwIG4gCjAwMDAwMDAzODAgMDAwMDAgbiAKdHJhaWxlcgo8PAogIC9TaXplIDYKICAvUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKNDkyCiUlRU9G" } } |
Requirements
| HTTP Method | GET, POST, DELETE, PUT |
| Payload Type | JSON, XML (only for PUSH) |
| Authentication Method | Basic Auth, Bearer Token or custom Authentication Header |