What is the Sesame API and what is it for?
The Sesame API is a tool designed to make it easy to integrate our platform with other software you use day to day. This capability is essential for companies working with complex technology ecosystems that need HR data to flow automatically and securely between systems.
If you work with multiple tools to manage your HR processes, payroll, time tracking, or Business Intelligence, the Sesame API lets you connect everything in a programmatic way, no manual intervention needed.
What resources can you manage with the API?
The API allows you to access and manipulate the platform's main resources programmatically. All available areas are detailed below:
|
Resource |
What you can do |
👤 |
Employees |
Create, update, delete and retrieve employee profiles. Manage profiles, assign managers, departments and offices from external systems such as ERPs or onboarding platforms. |
📄 |
Contracts |
Manage employee contracts including types, annexes and terminations. Retrieve active contracts, payroll data and job levels. |
💰 |
Salaries and compensation |
Manage base salaries, fixed compensation and monthly variable pay. Manage contribution groups for integration with payroll systems. |
⏰ |
Time tracking |
Log clock ins and clock outs, manage work breaks, validate clock ins and clock outs, and handle clock in/out incidences. |
🏖️ |
Time off and holidays |
Create and manage holiday and time off requests, configure holiday calendars and public holidays, approve or reject requests. |
📁 |
Documents |
List company directories, upload documents linked to employees and download files automatically. |
🏢 |
Organizational structure |
Retrieve and update departments, offices, entity groups, roles and employee assignments to each unit. |
💼 |
Recruitment |
Create and manage candidates, upload candidate documents and retrieve application status by vacancy. |
📊 |
Projects and time |
Manage projects, clients and planned tasks. Log time entries per project with start/stop. |
🎓 |
Training |
Create training courses, assign employees and track completion status for each course. |
💸 |
Expenses |
Retrieve company expenses, expense categories and configured payment methods. |
🔄 |
Shifts and scheduling |
Manage shifts, schedule templates, timetables and shift assignments to employees. |
📋 |
Surveys |
Retrieve company evaluations and respond to recruitment evaluations for candidates. |
🔧 |
Custom fields |
Create, update and delete custom fields to adapt employee data to each organization's needs. |
📨 |
Requests |
Retrieve custom requests and their types, access attached documents for each request. |
📈 |
Statistics |
Access statistical data on time tracking and overtime balance for report generation. |
What are the benefits of using the API?
With the API Add-on, you can synchronize data automatically between Sesame and other platforms, allowing you to:
- Reduce manual tasks and duplicate data errors by automatically syncing employees, contracts and salary data.
- Centralize your employee information, with Sesame acting as the single source of truth connected to all your systems.
- Automate operational processes such as clock ins/outs, time off, contract management and project time logging.
- Feed your Business Intelligence by exporting HR data to tools such as Power BI or Tableau.
Use cases
Here are some of the most common integrations our clients build with the Sesame HR API:
ERP ↔ Sesame synchronization
Automatically sync hires, leavers and contractual changes between your corporate ERP (SAP, Oracle, Microsoft Dynamics, etc.) and Sesame HR. When an employee is created in the ERP, they are automatically created in Sesame with all their data.
Payroll integration
Automatically transfer complete salary data (base salary, compensation, monthly variable pay and contribution groups) to your payroll software, eliminating manual data entry month after month.
Physical access control
Connect physical access control systems (turnstiles, card readers, biometric terminals) with Sesame HR to log clock ins/outs in real time using the clock in and clock out endpoints.
Business Intelligence export
Extract HR data (time tracking statistics, time off, hours by project, turnover) to BI tools such as Power BI, Tableau or Looker to generate executive dashboards.
Project time logging
Connect project management tools with the Time Entries endpoints to automatically log hours spent on each project and client.
Recruitment automation
Integrate external ATS platforms with Sesame to automatically sync candidates, documents and selection process statuses.
Sesame API technical details
Authentication
The API uses Bearer Token authentication. You must include your token in the Authorization header of each request:
Authorization: Bearer {your_token_here} |
You can obtain and manage your token from Configuration > Integrations > API within your Sesame HR panel.
Base URL and regional servers
The API has regional servers to ensure data residency. The base URL follows the format:
https://api-{region}.sesametime.com |
Where {region} is your region identifier (for example, eu1 for Europe).
Specification and versioning
The API follows the OpenAPI 3.0 specification (OAS 3.0) and is documented in Swagger format, making it easy to integrate with any programming language, technology platform or code generation tool.
Interactive documentation
You can explore all endpoints, test requests and view data schemas in our Swagger documentation at: apidocs.sesametime.com
🚀 The Sesame API is available as an Add-on. If you haven't activated it yet, contact your Account Manager or write to us via the support chat to start integrating. |