curl --request GET \
--url https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"personalData": {
"firstName": "<string>",
"lastName": "<string>",
"secondLastName": "<string>",
"birthDate": "1985-04-12",
"gender": "Masculino",
"maritalStatus": "<string>",
"nationality": "<string>",
"curp": "<string>",
"rfc": "<string>",
"socialSecurityNumber": "<string>",
"phone": "<string>",
"corporateEmail": "<string>"
},
"address": {
"street": "<string>",
"colonia": "<string>",
"municipality": "<string>",
"city": "<string>",
"federalState": "Veracruz",
"postalCode": "<string>",
"country": "<string>"
},
"employmentData": {
"employeeCode": "<string>",
"payrollGroup": "<string>",
"contractTypeCode": "<string>",
"contractTypeName": "<string>",
"contractCode": "<string>",
"workdayTypeName": "<string>",
"weeklyHours": 123,
"jobPosition": "<string>",
"professionalCategory": "<string>",
"department": "<string>",
"office": "<string>",
"hireDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"leaveReason": "<string>",
"shift": "<string>",
"imssEmployerRegistration": "<string>",
"federalStateIsn": "<string>",
"workerTypeName": "<string>",
"unionMember": true,
"economicZone": 1,
"expatriate": true,
"remoteWork": true,
"dependentChildrenCount": 123,
"disabilityPercentage": 123,
"benefitPlan": "<string>",
"contributionGroup": "<string>",
"seniorityDate": "2023-12-25",
"workDays": [
{
"day": "monday",
"hours": 8
}
]
},
"salaryData": {
"grossDailySalary": 123,
"grossAnnualSalary": 123,
"salaryTypeName": "<string>",
"payPeriod": "weekly",
"primaKey": "<string>",
"currency": "MXN",
"salaryStartDate": "2023-12-25",
"paymentsPerYear": 123,
"imssDisabilityAndLife": true,
"imssIllnessAndDeath": true,
"savingsFund": true,
"savingsAccount": true,
"groceryVouchers": true,
"foodVouchers": true,
"voucherCard": "<string>",
"voucherAccount": "<string>",
"profitSharing": true,
"aguinaldo": true,
"vacationBonus": true,
"annualDeclaration": true,
"incomeTaxWithholding": true,
"retroactivePay": true
},
"bankData": {
"bankName": "BBVA BANCOMER",
"accountType": "<string>",
"accountNumber": "<string>",
"beneficiaryName": "<string>",
"paymentMethod": "<string>"
},
"customFields": {}
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"total": 1,
"perPage": 1
}
}{
"message": "Invalid or missing API Key",
"code": "UNAUTHORIZED"
}{
"errors": "forbidden_access_permission",
"message": "forbidden_access_permission"
}{
"errors": "validator.invalid_employee_status",
"message": "validator.invalid_employee_status"
}{
"message": "Rate limit exceeded. Please try again later.",
"code": "RATE_LIMIT_EXCEEDED",
"retryAfter": 60
}List Mexican employees with their master payroll data
Returns a paginated list of the employees of the company of the token, with the master payroll data a Mexican payroll software needs: personal, address, employment, salary, bank and custom fields.
Requires the company country to be Mexico and the payroll module (or payroll addon) installed. Both gates return 403.
Use updatedSince for incremental synchronisation: pass the highest updatedAt you received in your previous call and you get only the employees changed since, across all 7 sources of the employee data. If nothing changed you get an empty list with 200, not a 404.
Ordering is fixed by the endpoint (most recently changed first, tie-broken by employee id) and is not configurable: a client-chosen order would make pagination unstable between pages.
curl --request GET \
--url https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{region}.sesametime.com/third-party-context/v1/all-mx-employee-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"personalData": {
"firstName": "<string>",
"lastName": "<string>",
"secondLastName": "<string>",
"birthDate": "1985-04-12",
"gender": "Masculino",
"maritalStatus": "<string>",
"nationality": "<string>",
"curp": "<string>",
"rfc": "<string>",
"socialSecurityNumber": "<string>",
"phone": "<string>",
"corporateEmail": "<string>"
},
"address": {
"street": "<string>",
"colonia": "<string>",
"municipality": "<string>",
"city": "<string>",
"federalState": "Veracruz",
"postalCode": "<string>",
"country": "<string>"
},
"employmentData": {
"employeeCode": "<string>",
"payrollGroup": "<string>",
"contractTypeCode": "<string>",
"contractTypeName": "<string>",
"contractCode": "<string>",
"workdayTypeName": "<string>",
"weeklyHours": 123,
"jobPosition": "<string>",
"professionalCategory": "<string>",
"department": "<string>",
"office": "<string>",
"hireDate": "2023-12-25",
"contractEndDate": "2023-12-25",
"leaveReason": "<string>",
"shift": "<string>",
"imssEmployerRegistration": "<string>",
"federalStateIsn": "<string>",
"workerTypeName": "<string>",
"unionMember": true,
"economicZone": 1,
"expatriate": true,
"remoteWork": true,
"dependentChildrenCount": 123,
"disabilityPercentage": 123,
"benefitPlan": "<string>",
"contributionGroup": "<string>",
"seniorityDate": "2023-12-25",
"workDays": [
{
"day": "monday",
"hours": 8
}
]
},
"salaryData": {
"grossDailySalary": 123,
"grossAnnualSalary": 123,
"salaryTypeName": "<string>",
"payPeriod": "weekly",
"primaKey": "<string>",
"currency": "MXN",
"salaryStartDate": "2023-12-25",
"paymentsPerYear": 123,
"imssDisabilityAndLife": true,
"imssIllnessAndDeath": true,
"savingsFund": true,
"savingsAccount": true,
"groceryVouchers": true,
"foodVouchers": true,
"voucherCard": "<string>",
"voucherAccount": "<string>",
"profitSharing": true,
"aguinaldo": true,
"vacationBonus": true,
"annualDeclaration": true,
"incomeTaxWithholding": true,
"retroactivePay": true
},
"bankData": {
"bankName": "BBVA BANCOMER",
"accountType": "<string>",
"accountNumber": "<string>",
"beneficiaryName": "<string>",
"paymentMethod": "<string>"
},
"customFields": {}
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"total": 1,
"perPage": 1
}
}{
"message": "Invalid or missing API Key",
"code": "UNAUTHORIZED"
}{
"errors": "forbidden_access_permission",
"message": "forbidden_access_permission"
}{
"errors": "validator.invalid_employee_status",
"message": "validator.invalid_employee_status"
}{
"message": "Rate limit exceeded. Please try again later.",
"code": "RATE_LIMIT_EXCEEDED",
"retryAfter": 60
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Page to return. Defaults to 1.
x >= 1Page size. Defaults to 150, which is also the maximum. A value above 150 returns 422 instead of being capped.
1 <= x <= 150Optional. If omitted or sent empty, returns the full download. When present, returns only employees changed on or after this instant, in any of the 7 sources of their data. Send an ISO-8601 value including the offset: without one it is interpreted in the server timezone. The comparison is inclusive, so replaying your previous cursor returns the boundary employee again.
"2026-08-01T00:00:00+00:00"
Absent or empty returns every employee, active and inactive. Deleted employees are never returned, with or without this filter.
active, inactive Was this page helpful?