TalentLyft API
TalentLyft API
Home
Help
Contact Us
About Us
Getting started
Customers Private API
Jobs
Candidates
Events
Account Members
Employees
Departments
Webhooks & Notifications
Customers Public API
Jobs
Locations
Departments
Partners API
Sourcing & Employee referrals
Job Boards
Assessments
Video Interviews
Background checks
HRIS & Onboarding
Powered by GitBook

Employees

Manage employee list for referral.

get
Get employees

https://api.talentlyft.com/v2/employees
Request
Response
Headers
Authorization
required
string
Authentication Bearer token
Query Parameters
eids
optional
array
​
departments
optional
array
​
contains
optional
string
​
page
optional
integer
Default value: 1
perPage
optional
integer
Default value: 20
sort
optional
string
Sort by first_name, last_name, department_name. Default value : first_name
200: OK
{
    "Results": [{
            "Id": 312,
            "FirstName": "Nikola",
            "LastName": "Biondic",
            "Email": "nikola.biondic@talentlyft.com",
            "ExternalId": null,
            "Department": null
        },
        {
            "Id": 786,
            "FirstName": "Ivan",
            "LastName": "Buntic",
            "Email": "ivan.buntic@talentlyft.com",
            "ExternalId": null,
            "Department": null
        },
        {
            "Id": 900,
            "FirstName": "John",
            "LastName": "Doe",
            "Email": "john.does@talentlyft.com",
            "ExternalId": null,
            "Department": null
        }
    ],
    "Count": 10,
    "Page": 1,
    "PerPage": 3,
    "Pages": {
        "First": "https://api.talentlyft.com//backend/employees?perPage=3",
        "Prev": null,
        "Next": "https://api.talentlyft.com//backend/employees?perPage=3&page=2",
        "Last": "https://api.talentlyft.com//backend/employees?perPage=3&page=4"
    }
}
401: Unauthorized
{
  "Message": "Unauthorized"
}
403: Forbidden
{
  "Message": "Forbidden"
}

get
Get employee

https://api.talentlyft.com/v2/employees/:id
Request
Response
Path Parameters
id
required
string
Unique identifier
Headers
Authorization
required
string
Authentication Bearer token
200: OK
{
	"Id": 23,
	"FirstName": "John",
	"LastName": "Doe",
	"Email": "john.doe@talentlyft.com",
	"ExternalId": "your_id",
	"Department": {
		"Id": 24,
		"Name": "Sales"
	}
}
401: Unauthorized
{
	"Message": "Unauthorized"
}
403: Forbidden
{
	"Message": "Unauthorized"
}
404: Not Found
{
	"Message": "Not Found"
}

post
Create employee

https://api.talentlyft.com/v2/employees
Request
Response
Headers
Authorization
required
string
Authentication Bearer token
Body Parameters
FirstName
required
string
​
LastName
required
string
​
Email
required
string
​
ExternalId
optional
string
​
Department.Id
optional
integer
​
200: OK
{
	"Id": 23,
	"FirstName": "John",
	"LastName": "Doe",
	"Email": "john.doe@talentlyft.com",
	"ExternalId": "your_id",
	"Department": {
		"Id": 24,
		"Name": "Sales"
	}
}

put
Update employee

https://api.talentlyft.com/v2/employees/:id
Request
Response
Headers
Authorization
required
string
Authentication Bearer token
Body Parameters
FirstName
required
string
​
LastName
required
string
​
Email
required
string
​
ExternalId
optional
string
​
Department.Id
optional
integer
​
204: No Content
​
401: Unauthorized
{
	"Message": "Unauthorized"
}
403: Forbidden
{
	"Message": "Unauthorized"
}
404: Not Found
{
	"Message": "Unauthorized"
}

delete
Delete employee

https://api.talentlyft.com/v2/employees/:id
Request
Response
Path Parameters
id
required
string
Unique identifier
Headers
Authorization
required
string
Authentication Bearer token
204: No Content
​
401: Unauthorized
{
	"Message": "Unauthorized"
}
403: Forbidden
{
	"Message": "Forbidden"
}
404: Not Found
{
	"Message": "Not Found"
}
Customers Private API - Previous
Account Members
Next - Customers Private API
Departments
Last updated Fri Jun 07 2019 20:25:29 GMT+0000 (UTC)
Contents
getGet employees
getGet employee
postCreate employee
putUpdate employee
deleteDelete employee