Referral Schnittstelle

Wichtiger Hinweis: Nicht alle unsere Endpunkte sind hier dokumentiert. Bitte kontaktieren Sie uns, um eine ausführliche Dokumentation zu erhalten.

Authentifizierung

Für eine erfolgreiche Authentifizierung müssen folgende Header gesetzt werden:

User-Source: this data will be communicated separately
X-Token: <Token>

Gamification-Punkte abrufen (Empfehlungsprogramm)

Mit dieser Methode können Sie alle Punkte abrufen, die allen Mitarbeitern in einem bestimmten Zeitraum gutgeschrieben wurden.

Call

GET

https://api.talentry.com/api/v1/tenants/<tenantId>/gamificationPointsReport/<startDate>/<endDate>

Das Datumsformat ist JJJJ-MM-TT. Die Uhrzeit wird als 00:00:00 Uhr für den Start und 23:59:59 Uhr für das Ende angenommen.

Response

[
   {
      "id": "q038tay42u0shux45tzdn8",
      "externalId": "21023",
      "email": "thomas.test@university.gov",
      "points": "235"
   },
   {
      "id": "zml0lllhetn7ir3a77v28n",
      "externalId": "8976",
      "email": "sanchez.test@university.gov",
      "points": "180"
   }
]

id (string) CleverConnects Mitarbeiter-ID
externalId (string oder null) ID des Mitarbeiters aus dem Kundensystem
email (string) E-Mail-Adresse des Mitarbeiters
points (integer) Gesamtpunktzahl des Mitarbeiters innerhalb des Zeitraums

Einstellungsprämien

Mit dieser Methode können Sie Bewerbungen und zugehörige Informationen zu Einstellungsprämien basierend auf der letzten Phasenänderung abrufen. Datum

Call

GET

https://api.talentry.com/api/v1/tenants/<customerId>/applications/<stageExternalId>/<startDate>/<endDate>

Das Datumsformat ist JJJJ-MM-TT. Die Uhrzeit wird als 00:00:00 Uhr für den Start und 23:59:59 Uhr für das Ende angenommen.

Response

{
[ 
   { 
      "applicationId": "0w1qydbqoxb249t883vpwa", 
      "applicationExternalId": null, 
      "applicationStageId": "hired", 
      "applicationLastStageChangeDate": "2023-06-21T11:45:01+0000", 
      "jobId": "2703", 
      "jobExternalId": null, 
      "talentFirstName": "First", 
      "talentLastName": "Last", 
      "talentEmail": "first.last@example.invalid", 
      "rewardTypeExternalId": "EUR", 
      "rewardAmount": 10, 
      "referrerEmployeeId": 1876, 
      "referrerExternalId": null, 
      "referrerStaffId" : "ABCDEF123456",
      "referrerFirstName": "First", 
      "referrerLastName": "Referrer", 
      "referrerEmail": "first.referrer@example.invalid", 
      "referrerCompanyExternalId": "5", 
      "referrerDepartmentExternalId": "14", 
      "referrerLocationExternalId": "12" 
   } 
] 
}