Referral API

Important note : Not all our endpoints are documented here. Please contact us to get the exhaustive documentation.

Authentication

In order to successfully authenticate the following headers must be set:

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

Get gamification points (referral program)

Use this method to get all points awarded to all employees during a specific period.

Call

GET

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

The format for the dates is YYYY-MM-DD and the time is assumed to be 00:00:00 for the start and 23:59:59 for the end one.

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) CleverConnect's employee ID
externalId (string or null) ID of the employee from the customer's system
email (string) Email of the employee
points (integer) Total points earned by the employee within the timeframe

Hiring rewards

Use this method to retrieve applications and associated hiring reward information based on the last stage change date

Call

GET

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

The format for the dates is YYYY-MM-DD and the time is assumed to be 00:00:00 for the start and 23:59:59 for the end one.

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" 
   } 
] 
}