Employees | TalentLyft API

TalentLyft API

Help Login Register Go to App Go to TalentLyft Request a Demo

Get employee

get

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/employees/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

500

{
  "Id": 1,
  "FirstName": "text",
  "LastName": "text",
  "Name": "text",
  "Email": "text",
  "ExternalId": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Department": {
    "Id": 1,
    "Name": "text"
  },
  "LastEmail": "2025-04-02T15:20:51.048Z"
}

Success

Delete employee

delete

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v2/employees/{id}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

500

No body

No Content

Get employees

get

Authorizations

Query parameters

eidsstring[]optional

departmentsinteger · int32[]optional

pageinteger · int32 · default: 1optional

perPageinteger · int32 · default: 20optional

sortstring · default: "first_name"optional

first_name, last_name, department_name

containsstringoptional

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/employees' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

500

{
  "Results": [
    {
      "Id": 1,
      "FirstName": "text",
      "LastName": "text",
      "Name": "text",
      "Email": "text",
      "ExternalId": "text",
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Department": {
        "Id": 1,
        "Name": "text"
      },
      "LastEmail": "2025-04-02T15:20:51.048Z"
    }
  ],
  "Count": 1,
  "Page": 1,
  "PerPage": 1,
  "Pages": {
    "First": "text",
    "Prev": "text",
    "Next": "text",
    "Last": "text"
  },
  "IdResults": [
    {
      "Id": 1,
      "FirstName": "text",
      "LastName": "text",
      "Name": "text",
      "Email": "text",
      "ExternalId": "text",
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Department": {
        "Id": 1,
        "Name": "text"
      },
      "LastEmail": "2025-04-02T15:20:51.048Z"
    }
  ],
  "OriginalCount": 1
}

Success

Create employee

post

Authorizations

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

Idinteger · int32optional

FirstNamestring | nullableoptional

LastNamestring | nullableoptional

Namestring | nullableoptional

Emailstring | nullableoptional

ExternalIdstring | nullableoptional

Uidstring · uuidoptional

Departmentobjectoptional

LastEmailstring · date-time | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2/employees' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "FirstName": "text",
    "LastName": "text",
    "Name": "text",
    "Email": "text",
    "ExternalId": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Department": {
      "Id": 1,
      "Name": "text"
    },
    "LastEmail": "2025-04-02T15:20:51.048Z"
  }'

201

401

403

422

500

{
  "Id": 1,
  "FirstName": "text",
  "LastName": "text",
  "Name": "text",
  "Email": "text",
  "ExternalId": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Department": {
    "Id": 1,
    "Name": "text"
  },
  "LastEmail": "2025-04-02T15:20:51.048Z"
}

Created

Save employee

put

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

Idinteger · int32optional

FirstNamestring | nullableoptional

LastNamestring | nullableoptional

Namestring | nullableoptional

Emailstring | nullableoptional

ExternalIdstring | nullableoptional

Uidstring · uuidoptional

Departmentobjectoptional

LastEmailstring · date-time | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v2/employees/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "FirstName": "text",
    "LastName": "text",
    "Name": "text",
    "Email": "text",
    "ExternalId": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Department": {
      "Id": 1,
      "Name": "text"
    },
    "LastEmail": "2025-04-02T15:20:51.048Z"
  }'

200

401

403

404

422

500

No body

Success

Sync all employees

post

Authorizations

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

FirstNamestring | nullableoptional

LastNamestring | nullableoptional

Emailstring | nullableoptional

ExternalIdstring | nullableoptional

Departmentstring | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2/employees/sync' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '[
    {
      "FirstName": "text",
      "LastName": "text",
      "Email": "text",
      "ExternalId": "text",
      "Department": "text"
    }
  ]'

201

401

403

404

500

No body

Created

Get employee

Delete employee

Get employees

Create employee

Show child attributes

Save employee

Show child attributes

Sync all employees