Hirely API Dokumentation

Die Hirely-API ist nach dem REST-Standard organisiert. Unsere API hat vorhersehbare ressourcenorientierte URLs, akzeptiert form-encoded Anfragen, gibt JSON-encoded Antworten zurück und verwendet standardmäßige HTTP-Antwortcodes und Authentifizierung.

Die Hirely-API unterstützt keine Massenaktualisierungen. Du kannst nur ein Objekt pro Anfrage bearbeiten.

Hinweis: Diese API wird aktuell noch stetig durch neue Endpunkte und Anwendungsmöglichkeiten erweitert. Sie deckt noch nicht alle Funktionen ab, welche in der Hirely WebApp möglich sind.

Base Url
https://hirely.de/api/v1

Authentifizierung

Die Hirely-API verwendet API-Schlüssel, um Anfragen zu authentifizieren. Du kannst API-Schlüssel in den Einstellungen deines Benutzerkontos erstellen, einsehen und verwalten:

  1. Öffne das Dashboard in Hirely unter https://app.hirely.de
  2. Klicke in der Navigationsleiste auf dein Profil
  3. Navigiere zu dem Menüpunkt “Benutzerkonto”
  4. Öffne den Tab “Entwickler-Einstellungen”
  5. Erstelle einen neuen API-Schlüssel, indem du auf “+ API-Schlüssel erstellen” klickst.

Jede Anfrage, die an die Hirely-API gesendet wird, muss einen Authorization-Header mit einem gültigen API-Schlüssel enthalten.

Deine API-Schlüssel sind mit allen Berechtigungen verbunden, die dein Benutzerkonto in dem angegebenen Unternehmen besitzt. Achte also darauf, dass du sie sicher aufbewahrst! Gib deine API-Schlüssel nicht in öffentlich zugänglichen Bereichen wie GitHub, Client-seitigem Code o. ä. weiter. Du kannst einzelne API-Schlüssel jederzeit löschen und somit unnutzbar machen.

Alle API-Anfragen müssen über HTTPS gestellt werden. Aufrufe, die über einfaches HTTP erfolgen, schlagen fehl. API-Anfragen ohne Authentifizierung werden ebenfalls fehlschlagen.

Authorization-Header
Key: Authorization Value: Bearer [API-Schlüssel]

Rate-Limiting

Die Hirely-API implementiert verschiedene Schutzvorkehrungen, um eine hohe Stabilität zu gewährleisten, indem sie die Menge an eingehenden Daten begrenzt. Benutzerkonten, die viele Anfragen in kurzer Zeit versenden, können möglicherweise Fehlermeldungen erhalten, die als Statuscode 429 angegeben sind. Unsere API enthält diverse Beschränkungen, darunter:

  • Eine Ratenbegrenzung, welche API Anfragen auf 75 Vorgänge innerhalb einer Minute begrenzt.

    Diese Begrenzung ist nicht auf einen API-Schlüssel limitiert, sondern gilt für alle Anfragen eines Benutzerkontos.

Um missbräuchliche Aktivitäten zu vermeiden oder Anwendungen mit höherem Datenvolumen zuzulassen, können wir die Grenzwerte der Ratenbegrenzung reduzieren oder erhöhen. Um eine höhere Beschränkung der Anfragen zu beantragen, kontaktiere bitte unseren Support. Wenn du eine erhebliche Erhöhung beantragen möchten, lasse uns dies bitte zwei Wochen vor Beginn der erhöhten Ratenbegrenzung wissen.

Fehler

Hirely verwendet herkömmliche HTTP-Antwortcodes, um den Erfolg oder Misserfolg einer API-Anfrage anzuzeigen. Im Allgemeinen: Codes im 2xx-Bereich zeigen eine erfolgreiche Anfrage an. Codes im 4xx-Bereich weisen auf einen Fehler hin, der aufgrund der angegebenen Informationen fehlgeschlagen ist (z. B. wurde ein erforderlicher Parameter ausgelassen usw.). Codes im Bereich 5xx weisen auf einen Fehler bei den Servern von Hirely hin (diese sind selten).

Einige 4xx-Fehler, die programmgesteuert bearbeitet werden können, enthalten einen Fehlercode, der den gemeldeten Fehler kurz erklärt.

Seitenzählung (Paginierung)

Alle API-Ressourcen der obersten Ebene unterstützen Massenabrufe. Du kannst zum Beispiel Bewerbungen, Stellenangebote und Unternehmen auflisten.

Die JSON-Antwort eines Massenabrufs enthält Metainformationen wie total, current_page, last_page und mehr. Die Ergebnisdatensätze sind über den Datenschlüssel im JSON-Array verfügbar.

Antwort eines Massenabrufes mit Paginierung
{ "data": [ ... ], "links": { "first": "https://hirely.de/api/v1/1000/applications?page=1", "last": "https://hirely.de/api/v1/1000/applications?page=684", "prev": null, "next": "https://hirely.de/api/v1/1000/applications?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 684, "links": [ { "url": null, "label": "pagination.previous", "active": false }, { "url": "https://hirely.de/api/v1/1000/applications?page=1", "label": "1", "active": true }, { "url": "https://hirely.de/api/v1/1000/applications?page=2", "label": "2", "active": false }, { "url": "https://hirely.de/api/v1/1000/applications?page=3", "label": "3", "active": false }, { "url": null, "label": "...", "active": false }, { "url": "https://hirely.de/api/v1/1000/applications?page=683", "label": "683", "active": false }, { "url": "https://hirely.de/api/v1/1000/applications?page=684", "label": "684", "active": false }, { "url": "https://hirely.de/api/v1/1000/applications?page=2", "label": "pagination.next", "active": false } ], "path": "https://hirely.de/api/v1/1000/applications", "per_page": 15, "to": 15, "total": 10247 } }

Benutzerkonto

Dieses Objekt enthält Daten zu dem Benutzerkonto, welches zu dem API-Schlüssel gehört. Mit dieser Abfrage kannst du sicherstellen, dass dein API-Schlüssel aktiv ist und dass die Hirely API korrekt angesprochen wird.

id
integer
Einzigartige ID des Benutzers.
firstname
string
Der Vorname des Benutzers.
surname
string
Der Nachname des Benutzers.
fullName
string
Der vollständige Name des Benutzers.
email
string
Die E-Mail-Adresse des Benutzers.
tokenName
string
Der Name des aktuellen API-Schlüssels, welcher bei der Erstellung vom Benutzer eingetragen wurde.
Endpunkt
GET /me
Antwort
{ "data": { "id": 1000, "firstname": "Max", "surname": "Mustermann", "fullName": "Max Mustermann", "email": "max@mustermann.de", "tokenName": "Zapier-Integration" } }

Unternehmen

Dieses Objekt repräsentiert ein Unternehmen, das in Hirely angelegt wurde. Du kannst nur Informationen von den Unternehmen abrufen, auf die dein Benutzerkonto Zugriff hat.

Endpunkte
GET /companies GET /companies/:id

Das Unternehmens-Objekt

id
integer
Einzigartige ID des Unternehmens.
name
string
Der Name des Unternehmens.
links
Objekt
Enthält Informationen zu diversen Links des Unternehmens.
links.publicWebsiteUrl
string, optional
Die URL zur Website des Unternehmens.
links.careerSiteUrl
string
Die URL zur Hirely-Karriereseite des Unternehmens.
links.imprintUrl
string, optional
Die URL zum Impressum des Unternehmens.
links.dataProtectionUrl
string, optional
Die URL zur Datenschutzverordnung des Unternehmens.
branding
Objekt
Enthält Informationen zum Branding des Unternehmens.
branding.logoUrl
string, optional
Die URL zum Logo des Unternehmens.
branding.faviconUrl
string, optional
Die URL zum Favicon des Unternehmens. Dieses besitzt immer eine größe von 32x32 Pixeln.
branding.logoSize
array enthält integer, optional
Die Maße des Logos in Pixel. Der erste Wert ist die Breite, der zweite die Höhe.
locationAmount
integer
Die Anzahl an Standorten des Unternehmens.
jobOfferAmount
integer
Die Anzahl an Stellenangeboten des Unternehmens.
userAmount
integer
Die Anzahl an Benutzern, die auf das Unternehmen zugriff haben.
applicationsAmount
integer
Die Anzahl an Bewerbungen, die das Unternehmen erhalten hat.
managedBy
integer, optional
Die einzigartige ID des Unternehmens, welche das Unternehmen verwaltet. Diese ID ist nur ausgefüllt, wenn das Unternehmen von einer Agentur angelegt wurde.
Das Unternehmens-Objekt
{ "id": 1001, "name": "Musterfirma GmbH", "links": { "publicWebsiteUrl": "https://www.musterfirma.de/", "careerSiteUrl": "https://musterfirma.hirely.de/", "imprintUrl": "https://www.musterfirma.de/impressum/", "dataProtectionUrl": null }, "branding": { "logoUrl": "https://musterfirma.hirely.de/logo.png", "faviconUrl": null, "logoSize": [ 999, 142 ] }, "locationAmount": 2, "jobOfferAmount": 14, "userAmount": 8, "applicationsAmount": 468, "managedBy": null, "createdAt": "2022-11-25T08:33:46.000000Z", "updatedAt": "2022-11-26T06:33:08.000000Z" }

Alle Unternehmen auflisten

Gibt eine Liste der Unternehmen zurück, auf die dein Benutzerkonto zugriff hat. Die Unternehmen werden in sortierter Reihenfolge zurückgegeben, wobei die zuletzt erstellten Unternehmen zuerst angezeigt werden.

Parameter

page
integer, optional
Wechselt auf die nächste Seite.
Endpunkt
GET /companies
Antwort
{ "data": [ { "id": 1001, "name": "Musterfirma GmbH", "links": { "publicWebsiteUrl": "https://www.musterfirma.de/", "careerSiteUrl": "https://musterfirma.hirely.de/", "imprintUrl": "https://www.musterfirma.de/impressum/", "dataProtectionUrl": null }, "branding": { "logoUrl": "https://musterfirma.hirely.de/logo.png", "faviconUrl": null, "logoSize": [ 999, 142 ] }, "locationAmount": 2, "jobOfferAmount": 14, "userAmount": 8, "applicationsAmount": 468, "managedBy": null, "createdAt": "2022-11-25T08:33:46.000000Z", "updatedAt": "2022-11-26T06:33:08.000000Z" }, {...}, {...} ], "links": { "first": "https://hirely.de/api/v1/companies?page=1", "last": "https://hirely.de/api/v1/companies?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "pagination.previous", "active": false }, { "url": "https://hirely.de/api/v1/companies?page=1", "label": "1", "active": true }, { "url": null, "label": "pagination.next", "active": false } ], "path": "https://hirely.de/api/v1/companies", "per_page": 15, "to": 3, "total": 3 } }

Ein Unternehmen abrufen

Ruft die Details eines Unternehmens ab, welches zuvor erstellt wurde. Gib die eindeutige Unternehmens-ID an, die bei deiner vorherigen Abfrage zurückgegeben wurde und Hirely gibt die entsprechenden Unternehmensinformationen zurück. Die gleichen Informationen werden zurückgegeben, wenn du ein Unternehmen erstellst oder aktualisierst.

Parameter

Keine Parameter
Endpunkt
GET /companies/:id
Antwort
{ "data": { "id": 1001, "name": "Musterfirma GmbH", "links": { "publicWebsiteUrl": "https://www.musterfirma.de/", "careerSiteUrl": "https://musterfirma.hirely.de/", "imprintUrl": "https://www.musterfirma.de/impressum/", "dataProtectionUrl": null }, "branding": { "logoUrl": "https://musterfirma.hirely.de/logo.png", "faviconUrl": null, "logoSize": [ 999, 142 ] }, "locationAmount": 2, "jobOfferAmount": 14, "userAmount": 8, "applicationsAmount": 468, "managedBy": null, "createdAt": "2022-11-25T08:33:46.000000Z", "updatedAt": "2022-11-26T06:33:08.000000Z" } }

Stellenangebote

In einem Stellenangebot werden die spezifischen Informationen eines Jobs angegeben, den ein Unternehmen zu vergeben hat. Hierbei kann es sich um die Anforderungen, die Vergütung oder auch die Arbeitszeiten handeln.

Endpunkte
GET /:companyId/jobOffers GET /:companyId/jobOffers/:id

Das Stellenangebot-Objekt

id
integer
Einzigartige ID des Stellenangebotes.
companyId
integer
Einzigartige ID des Unternehmens, für welches das Stellenangebot erstellt wurde.
locationId
integer
Einzigartige ID des Unternehmens-Standortes, für welches das Stellenangebot erstellt wurde.
status
Objekt
Enthält Informationen zum aktuellen Status des Stellenangebotes.
status.id
integer
Die Status-ID des Stellenangebotes.
status.name
string
Der Name des Status.
name
string
Der Name des Stellenangebotes
links
Objekt
Enthält Informationen zu diversen Links des Stellenangebotes.
links.jobOffer
string
Die URL, über welche das Stellenangebot aufgerufen werden kann.
links.applicationForm
string
Die URL, über welche das Bewerbungsformular des Stellenangebotes aufgerufen werden kann.
details
Objekt
Enthält Informationen zu den Details des Stellenangebotes.
details.employmentType.id
integer
Die ID der Beschäftigungsart.
details.employmentType.name
string
Der Name der Beschäftigungsart.
details.jobLimitation.id
integer
Die ID der Befristung.
details.jobLimitation.name
string
Der Name der Befristung.
details.remoteJob.id
integer
Die ID des Remote-Job Wertes.
details.remoteJob.name
string
Der Name des Remote-Job Wertes.
details.remoteJob.short_name
string
Der Kurzform des Remote-Job Namens.
details.weeklyWorkingHours.min
integer, optional
Die minimalen Arbeitsstunden pro Woche.
details.weeklyWorkingHours.max
integer, optional
Die maximalen Arbeitsstunden pro Woche.
details.salary.type
integer
Die ID der Vergütungsart.
details.salary.typeName
string
Der Name der Vergütungsart.
details.salary.min
integer, optional
Das Mindestgehalt der gewählten Vergütungsart.
details.salary.max
integer, optional
Das Maximalgehalt der gewählten Vergütungsart. Ist null, wenn keine Gehaltsspanne angegeben wurde.
details.vacationDays
integer, optional
Die Anzahl an jährlichen Urlaubstagen.
details.jobStart
string, optional
Das Datum, wann der Job beginnt.
Format: YYYY-mm-dd
details.applicationDeadline
string, optional
Das Datum der Bewerbungsfrist
Format: YYYY-mm-dd
details.text.introduction
text, optional
Der HTML-Text der Einleitung des Stellenangebotes.
details.text.tasks
text, optional
Der HTML-Text der Aufgaben des Stellenangebotes.
details.text.requirements
text, optional
Der HTML-Text des Anforderungsprofils des Stellenangebotes.
details.text.advantages
text, optional
Der HTML-Text der Vorteile / Benefits des Stellenangebotes.
employeesNeeded
integer
Die Anzahl, wie viele Mitarbeiter für diesen Job benötigt werden. Muss höher als 0 sein.
Das Stellenangebot-Objekt
{ "id": 4568, "companyId": 1000, "locationId": 1000, "status": { "id": 1, "name": "Öffentlich" }, "name": "Bereichsleiter", "links": { "jobOffer": "https://musterfirma.hirely.de/bereichsleiter", "applicationForm": "https://musterfirma.hirely.de/bereichsleiter/bewerben" }, "details": { "employmentType": { "id": 5, "name": "Midijob" }, "jobLimitation": { "id": 0, "name": "Keine Angabe" }, "remoteJob": { "id": 2, "name": "Remote-Job möglich", "short_name": "Möglich" }, "weeklyWorkingHours": { "min": 37, "max": 40 }, "salary": { "type": 1, "typeName": "Stunde", "min": 18, "max": null }, "vacationDays": 27, "jobStart": "2023-02-12", "applicationDeadline": "2023-01-20", "text": { "introduction": null, "tasks": null, "requirements": null, "advantages": null } }, "employeesNeeded": 8, "createdAt": "2022-12-11T21:32:19.000000Z", "updatedAt": "2023-01-17T08:07:33.000000Z" }

Alle Stellenangebote auflisten

Gibt eine Liste der Stellenangebote eines Unternehmens zurück. Die Stellenangebote werden in sortierter Reihenfolge zurückgegeben, wobei das zuletzt erstellte Stellenangebot zuerst angezeigt wird.

Parameter

page
integer, optional
Wechselt auf die nächste Seite.
Endpunkt
GET /:companyId/jobOffers
Antwort
{ "data": [ { "id": 4568, "companyId": 1000, "locationId": 1000, [...] }, {...}, {...} ], "links": { "first": "https://hirely.de/api/v1/1000/jobOffers?page=1", "last": "https://hirely.de/api/v1/1000/jobOffers?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "pagination.previous", "active": false }, { "url": "https://hirely.de/api/v1/1000/jobOffers?page=1", "label": "1", "active": true }, { "url": null, "label": "pagination.next", "active": false } ], "path": "https://hirely.de/api/v1/1000/jobOffers", "per_page": 15, "to": 8, "total": 8 } }

Ein Stellenangebot abrufen

Ruft die Details eines Stellenangebotes ab, welches zuvor erstellt wurde. Gib die eindeutige Unternehmens-ID und Stellenangebot-ID an, die bei deiner vorherigen Abfrage zurückgegeben wurde und Hirely gibt die entsprechenden Informationen des Stellenangebotes zurück. Die gleichen Informationen werden zurückgegeben, wenn du ein Stellenangebot erstellst oder aktualisierst.

Parameter

Keine Parameter
Endpunkt
GET /:companyId/jobOffers/:id
Antwort
{ "data": { "id": 4568, "companyId": 1000, "locationId": 1000, "status": { "id": 1, "name": "Öffentlich" }, "name": "Bereichsleiter", "links": { "jobOffer": "https://musterfirma.hirely.de/bereichsleiter", "applicationForm": "https://musterfirma.hirely.de/bereichsleiter/bewerben" }, "details": { "employmentType": { "id": 5, "name": "Midijob" }, "jobLimitation": { "id": 0, "name": "Keine Angabe" }, "remoteJob": { "id": 2, "name": "Remote-Job möglich", "short_name": "Möglich" }, "weeklyWorkingHours": { "min": 37, "max": 40 }, "salary": { "type": 1, "typeName": "Stunde", "min": 18, "max": null }, "vacationDays": 27, "jobStart": "2023-02-12", "applicationDeadline": "2023-01-20", "text": { "introduction": null, "tasks": null, "requirements": null, "advantages": null } }, "employeesNeeded": 8, "createdAt": "2022-12-11T21:32:19.000000Z", "updatedAt": "2023-01-17T08:07:33.000000Z" } }

Bewerbungen

Dieses Objekt stellt eine Bewerbung für ein Stellenangebot dar. Bewerbungen können von der API oder über das Bewerbungsformular erstellt worden sein.

Endpunkte
GET /:companyId/applications GET /:companyId/applications/:id POST /:companyId/applications/

Das Bewerbungs-Objekt

id
integer
Einzigartige ID der Bewerbung.
companyId
integer
Einzigartige ID des Unternehmens, für welche die Bewerbung abgeschickt wurde.
jobOfferId
integer
Einzigartige ID des Stellenangebotes, für welche die Bewerbung abgeschickt wurde.
salutation
Objekt
Enthält Informationen zur Anrede des Bewerbers.
salutation.id
integer
Die ID der Anrede.
salutation.name
string
Der Name der Anrede.
firstname
string
Der Vorname des Bewerbers.
surname
string
Der Nachname des Bewerbers.
email
string
Die E-Mail-Adresse des Bewerbers.
phone
string, optional
Die Telefonnummer des Bewerbers.
birthday
string, optional
Das Geburtsdatum des Bewerbers im Format YYYY-mm-dd.
coverLetter
text, optional
Das Anschreiben des Bewerbers.
files
Array aus Objekten, optional
Enthält informationen zu den vom Bewerber hochgeladenen Dateien.
files.resume
Objekt mit Dateiinformationen, optional
Der Lebenslauf des Bewerbers.
files.testimonies
Objekt-Array mit Dateiinformationen, optional
Die Zeugnisse des Bewerbers.
files.certificates
Objekt-Array mit Dateiinformationen, optional
Die Zertifikate des Bewerbers.
files.furtherFiles
Objekt-Array mit Dateiinformationen, optional
Die weiteren Anlagen des Bewerbers.
customFields
Array aus Objekten, optional
Listet die individuellen Auswahlfragen auf, die der Bewerber angegeben hat.
customFields[0].question
string
Die Frage, auf die der Bewerber geantwortet hat.
customFields[0].answer_type.name
string
Der Name der Antwort-Art.
customFields[0].answer_type.id
integer
Die ID der Antwort-Art.
customFields[0].answer
string
Die vom Bewerber angegebene Antwort.
customFields[0].possibleAnswers
Array aus strings
Gibt die vordefinierten Antwortmöglichkeiten an, aus welchen der Bewerber auswählen kann.
Das Bewerbungs-Objekt
{ "id": 48324, "companyId": 1000, "jobOfferId": 5384, "salutation": { "id": 1, "name": "Herr" }, "firstname": "Max", "surname": "Mustermann", "email": "max@mustermann.de", "phone": "+49 (0) 123 456789", "birthday": "2000-28-02", "coverLetter": "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Possimus, tenetur!", "files": { "resume": { "fileName": "Lebenslauf.doc", "downloadUrl": "https://app.hirely.de/download/attachment/[...]", "mimeType": "application/msword" }, "testimonies": [ { "fileName": "Zeugnis_Realschule_gescannt.jpg", "downloadUrl": "https://app.hirely.de/download/attachment/[...]", "mimeType": "image/jpeg" }, {...}, {...}, ], "certificates": [ { "fileName": "Datev_Zertifikat.jpg", "downloadUrl": "https://app.hirely.de/download/attachment/[...]", "mimeType": "image/jpeg" }, {...}, {...}, ], "furtherFiles": [ { "fileName": "Führerschein_Kopie.jpg", "downloadUrl": "https://app.hirely.de/download/attachment/[...]", "mimeType": "image/jpeg" }, {...}, {...}, ] }, "customFields": [ { "question": "Testzeile (1)", "answer_type": { "name": "Eine Zeile", "id": 1 }, "answer": "Antwort Feld 1", "possibleAnswers": [] }, { "question": "Testzeile (Optional)", "answer_type": { "name": "Eine Zeile", "id": 1 }, "answer": "Antwort Feld 2", "possibleAnswers": [] }, { "question": "Ja/Nein Frage", "answer_type": { "name": "Ja / Nein", "id": 3 }, "answer": "Nein", "possibleAnswers": [ "Ja", "Nein" ] }, { "question": "Das ist die Mehrfachauswahl", "answer_type": { "name": "Mehrfachauswahl", "id": 4 }, "answer": [ "Antwortmöglichkeit 1", "Antwortmöglichkeit 2" ], "possibleAnswers": [ "Antwortmöglichkeit 1", "Antwortmöglichkeit 2", "Antwortmöglichkeit 3" ] }, { "question": "Einfache Auwahl", "answer_type": { "name": "Eine Wahl", "id": 5 }, "answer": "Antwortmöglichkeit 2", "possibleAnswers": [ "Antwortmöglichkeit 1", "Antwortmöglichkeit 2", "Antwortmöglichkeit 3" ] } ], "createdAt": "2023-01-17T07:52:43.000000Z", "updatedAt": "2023-01-17T08:07:41.000000Z" }

Alle Bewerbungen eines Unternehmens auflisten

Gibt eine Liste der Bewerbungen zurück, die ein Unternehmen erhalten hat. Die Bewerbungen werden in sortierter Reihenfolge zurückgegeben, wobei die zuletzt erstellten Bewerbungen zuerst angezeigt werden.

Parameter

page
integer, optional
Wechselt auf die nächste Seite.
Endpunkt
GET /:companyId/applications
Antwort
{ "data": [ { "id": 48324, "companyId": 1000, "jobOfferId": 5384, [...] } {...}, {...} ], "links": { "first": "https://hirely.de/api/v1/1001/applications?page=1", "last": "https://hirely.de/api/v1/1001/applications?page=2", "prev": null, "next": "https://hirely.de/api/v1/1001/applications?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 2, "links": [ { "url": null, "label": "pagination.previous", "active": false }, { "url": "https://hirely.de/api/v1/1001/applications?page=1", "label": "1", "active": true }, { "url": "https://hirely.de/api/v1/1001/applications?page=2", "label": "2", "active": false }, { "url": "https://hirely.de/api/v1/1001/applications?page=2", "label": "pagination.next", "active": false } ], "path": "https://hirely.de/api/v1/1001/applications", "per_page": 15, "to": 15, "total": 22 } }

Eine Bewerbung abrufen

Ruft die Details einer Bewerbung ab, welche zuvor erstellt wurde. Gib die eindeutige Unternehmens-ID und Bewerbungs-ID an, die bei deiner vorherigen Abfrage zurückgegeben wurde und Hirely gibt die entsprechenden Bewerbungsinformationen zurück. Die gleichen Informationen werden zurückgegeben, wenn du eine Bewerbung erstellst oder aktualisierst.

Parameter

Keine Parameter
Endpunkt
GET /:companyId/applications/:id
Antwort
{ "data": { "id": 45684, "companyId": 4562, "jobOfferId": 1530, "salutation": { "id": 1, "name": "Herr" }, "firstname": "Max", "surname": "Mustermann", "email": "max@mustermann.de", "phone": "+49 (0) 1234 56789", "birthday": "2000-02-28", "coverLetter": null, "files": { "resume": [], "testimonies": [], "certificates": [], "furtherFiles": [] }, "customFields": [], "createdAt": "2023-01-17T07:52:43.000000Z", "updatedAt": "2023-01-17T08:07:41.000000Z" } }

Eine Bewerbung erstellen

Erstellt eine neue Bewerbung.

Parameter

jobOfferId
pflichtfeld
Die ID des Stellenangebotes, für welche diese Bewerbung erstellt werden soll.
firstname
pflichtfeld Max. 100 Zeichen
Der Vorname des Bewerbers.
surname
pflichtfeld Max. 100 Zeichen
Der Nachname des Bewerbers.
email
pflichtfeld Max. 100 Zeichen
Die E-Mail-Adresse des Bewerbers. Wird eine ungültige E-Mail-Adresse angegeben, schlägt die Erstellung fehl.
salutation
pflichtfeld
Die Anrede des Bewerbers. Muss eine der folgenden integer enthalten: 0 = Divers, 1 = Herr, 2 = Frau.
phone
optional Max. 100 Zeichen
Die Telefonnummer des Bewerbers. Es wird kein spezielles Format benötigt.
birthday
optional
Das Geburtsdatum des Bewerbers im Format YYYY-mm-dd. Dieser Wert muss in der Vergangenheit liegen (max. 150 Jahre).
coverLetter
optional Max. 65.000 Zeichen
Das Anschreiben des Bewerbers.
sendMail
optional
Array aus Einstellungen zum versenden von E-Mails
sendMail.toTeam
optional default: true boolean
Bestimme, ob andere Benutzer, die Zugang zur Bewerbung haben, eine E-Mail-Benachrichtigung über den Empfang der Bewerbung erhalten sollen. Muss true oder false sein.
Endpunkt
POST /:companyId/applications
Anfrage
{ "jobOfferId": 1003, "salutation": 1, "firstname": "Maximilian", "surname": "Mustermann", "email": "max@mustermann.de", "phone": "+49 (0) 1234 56789", "birthday": "2000-02-28", "coverLetter": "Hallo, dies ist mein Anschreiben.", "sendMail": { "toTeam": true } }
Antwort
{ "data": { "id": 11336, "companyId": 1001, "jobOfferId": 1003, "salutation": { "id": 1, "name": "Herr" }, "firstname": "Maximilian", "surname": "Mustermann", "email": "max@mustermann.de", "phone": "+49 (0) 1234 56789", "birthday": "2000-02-28", "coverLetter": "Hallo, dies ist mein Anschreiben.", "files": { "resume": [], "testimonies": [], "certificates": [], "furtherFiles": [] }, "customFields": [], "createdAt": "2023-02-04T17:18:55.000000Z", "updatedAt": "2023-02-04T17:18:55.000000Z" } }