Employees
Authorizations
Query parameters
eidsstring[]Optional
departmentsinteger · int32[]Optional
pageinteger · int32OptionalDefault:
1
perPageinteger · int32OptionalDefault:
20
sortstringOptionalDefault:
first_name, last_name, department_name
first_name
containsstringOptional
Header parameters
X-TL-CompanyIdguidOptional
Company Id
X-TL-SubdomainguidOptional
Account subdomain
X-TL-UserIdguidOptional
Team member id
Responses
200
Success
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
500
Server Error
application/json
get
GET /v2/employees HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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-06-27T09:08:58.001Z"
}
],
"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-06-27T09:08:58.001Z"
}
],
"OriginalCount": 1
}
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
LastEmailstring · date-time | nullableOptional
Responses
201
Created
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
422
Client Error
application/json
500
Server Error
application/json
post
POST /v2/employees HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 214
{
"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-06-27T09:08:58.001Z"
}
{
"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-06-27T09:08:58.001Z"
}
Authorizations
Path parameters
idinteger · int32Required
Header parameters
X-TL-CompanyIdguidOptional
Company Id
X-TL-SubdomainguidOptional
Account subdomain
X-TL-UserIdguidOptional
Team member id
Responses
200
Success
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Server Error
application/json
get
GET /v2/employees/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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-06-27T09:08:58.001Z"
}
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
LastEmailstring · date-time | nullableOptional
Responses
200
Success
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Client Error
application/json
500
Server Error
application/json
put
PUT /v2/employees/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 214
{
"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-06-27T09:08:58.001Z"
}
No content
Authorizations
Path parameters
idinteger · int32Required
Header parameters
X-TL-CompanyIdguidOptional
Company Id
X-TL-SubdomainguidOptional
Account subdomain
X-TL-UserIdguidOptional
Team member id
Responses
204
No Content
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Server Error
application/json
delete
DELETE /v2/employees/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
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
201
Created
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
500
Server Error
application/json
post
POST /v2/employees/sync HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 95
[
{
"FirstName": "text",
"LastName": "text",
"Email": "text",
"ExternalId": "text",
"Department": "text"
}
]
No content
Last updated