# Sesame HR Sesame Public API API

> Sesame HR Sesame Public API API on Apizie: 119 endpoints (Show Token Info, Update a company, List employees, Create an employee, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:sesame-hr/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:sesame-hr`
- Category: Finance
- Status: byok
- Source: https://sesamehr.com
- Page: https://www.apizie.tech/api/finance/sesame-hr
- OpenAPI: https://www.apizie.tech/api/finance/sesame-hr/openapi.json

Sesame HR provides a comprehensive HR management platform that streamlines processes such as employee onboarding, time tracking, performance management, and payroll. Their intuitive interface and automation tools help…

## Endpoints

### Show Token Info
`GET https://www.apizie.tech/v1/finance:sesame-hr/security-get-token-info` (byok)

### Update a company
`POST https://www.apizie.tech/v1/finance:sesame-hr/company-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Company ID |
| body | object | yes | JSON request body |

### List employees
`GET https://www.apizie.tech/v1/finance:sesame-hr/employees-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | integer | no | Find Employee by code |
| dni | string | no | Find Employee by dni |
| email | string | no | Find Employee by email |
| departmentIds | array | no | Find Employee by department Ids |
| officeIds | array | no | Find Employee by office Ids |
| limit | integer | no | Limit employees |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |
| status | string | no | Supported operators: in |

### Create an employee
`POST https://www.apizie.tech/v1/finance:sesame-hr/employees-create-new-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get an employee
`GET https://www.apizie.tech/v1/finance:sesame-hr/employees-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Employee ID |

### Update an employee
`POST https://www.apizie.tech/v1/finance:sesame-hr/employees-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Employee ID |
| body | object | yes | JSON request body |

### Delete an employee
`POST https://www.apizie.tech/v1/finance:sesame-hr/employees-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Employee ID |

### List employee managers
`GET https://www.apizie.tech/v1/finance:sesame-hr/employee-managers-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | Find employee managers by employeeId |
| managerId | string | no | Find employee managers by managerId |
| permission | string | no | Supported operators: in |
| limit | integer | no | Limit departments |
| page | integer | no | Request a specific page |

### Assign an employee manager
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-managers-assign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete an employee manager
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-managers-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Employee manager ID |

### List Roles
`GET https://www.apizie.tech/v1/finance:sesame-hr/roles-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit departments |
| page | integer | no | Request a specific page |

### List Assignations Roles by Employee
`GET https://www.apizie.tech/v1/finance:sesame-hr/employee-assignations-roles-list-by-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | yes | Employee Id |
| limit | integer | no | Limit departments |
| page | integer | no | Request a specific page |

### Assign Role
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-assignations-roles-assign-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Unassign Role
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-assignations-roles-unassign-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List departments
`GET https://www.apizie.tech/v1/finance:sesame-hr/departments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | Find Department by name |
| limit | integer | no | Limit departments |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### Create a department
`POST https://www.apizie.tech/v1/finance:sesame-hr/departments-create-new-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update a department
`POST https://www.apizie.tech/v1/finance:sesame-hr/departments-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Department ID |
| body | object | yes | JSON request body |

### Delete a department
`POST https://www.apizie.tech/v1/finance:sesame-hr/departments-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Department ID |

### List employee department assignation
`GET https://www.apizie.tech/v1/finance:sesame-hr/employee-department-assignations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | Find Assignation by employeeId |
| departmentId | string | no | Find Assignation by departmentId |
| limit | integer | no | Limit assignations |
| page | integer | no | Request a specific page |

### Assign an employee to a department
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-department-assignations-assign-department-to-employ` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Unassign employee from department
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-department-assignations-unassign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List offices
`GET https://www.apizie.tech/v1/finance:sesame-hr/offices-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | Find office by name |
| limit | integer | no | Limit offices |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### Create a office
`POST https://www.apizie.tech/v1/finance:sesame-hr/offices-create-office` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update an office
`POST https://www.apizie.tech/v1/finance:sesame-hr/offices-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Office ID |
| body | object | yes | JSON request body |

### Delete an office
`POST https://www.apizie.tech/v1/finance:sesame-hr/offices-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Office ID |

### List employee office assignation
`GET https://www.apizie.tech/v1/finance:sesame-hr/employee-office-assignations-list-assignations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | Find Assignation by employeeId |
| officeId | string | no | Find Assignation by officeId |
| limit | integer | no | Limit assignations |
| page | integer | no | Request a specific page |

### Assign an employee to an office
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-office-assignations-assign-employee-to-office` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Unassign employee from office
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-office-assignations-unassign-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List custom fields
`GET https://www.apizie.tech/v1/finance:sesame-hr/custom-fields-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit custom fields |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### Create a custom field
`POST https://www.apizie.tech/v1/finance:sesame-hr/custom-fields-create-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update a custom field
`POST https://www.apizie.tech/v1/finance:sesame-hr/custom-fields-update-field-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Custom field ID |
| body | object | yes | JSON request body |

### Delete a custom field
`POST https://www.apizie.tech/v1/finance:sesame-hr/custom-fields-delete-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Custom field ID |

### Starts a new work entry right now
`POST https://www.apizie.tech/v1/finance:sesame-hr/work-entries-start-new-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Ends the last work entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/work-entries-end-last-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Company Work Entries
`GET https://www.apizie.tech/v1/finance:sesame-hr/work-entries-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | The id of the employee |
| from | string | no | Y-m-d |
| to | string | no | Y-m-d |
| updatedAt[gte] | string | no | UpdatedAt greater or equal |
| updatedAt[lte] | string | no | UpdatedAt lesser or equal |
| onlyReturn | string | no | Return specific users |
| limit | integer | no | Limit work entries |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### Create Work Entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/work-entries-create-new-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update Work Entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/work-entries-update-work-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Work Entry ID |
| body | object | yes | JSON request body |

### Delete Work Entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/work-entries-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Work Entry ID |

### List Check Types
`GET https://www.apizie.tech/v1/finance:sesame-hr/check-types-list-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List Work Breaks
`GET https://www.apizie.tech/v1/finance:sesame-hr/work-breaks-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List Check Validation By Employees and Status
`GET https://www.apizie.tech/v1/finance:sesame-hr/check-validation-list-by-employees-and-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds[in] | array | no | EmployeeIds to query |
| status | string | no | Allowed Status |
| from | string | no | Request a date from |
| to | string | no | Request a date to |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List Worked Hours By Employee
`GET https://www.apizie.tech/v1/finance:sesame-hr/statistics-list-worked-hours-by-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds[in] | array | no | Array of employee ids |
| withChecks | boolean | no | true or false |
| from | string | yes | Y-m-d |
| to | string | yes | Y-m-d |
| limit | integer | no | Limit employees |
| page | integer | no | Request a specific page |

### List Worked Hours By Employee and Week Day
`GET https://www.apizie.tech/v1/finance:sesame-hr/statistics-list-worked-hours-by-week-day` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds[in] | array | no | Array of employee ids |
| from | string | yes | Y-m-d |
| to | string | yes | Y-m-d |
| limit | integer | no | Limit employees |
| page | integer | no | Request a specific page |

### List Worked Hours By Employee In Night Hours
`GET https://www.apizie.tech/v1/finance:sesame-hr/statistics-list-worked-night-hours` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds[in] | array | no | Array of employee ids |
| withChecks | boolean | no | true or false |
| from | string | yes | Y-m-d |
| to | string | yes | Y-m-d |
| limit | integer | no | Limit employees |
| page | integer | no | Request a specific page |

### List Worked Absence Days By Employee
`GET https://www.apizie.tech/v1/finance:sesame-hr/statistics-list-worked-absence-days-by-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds[in] | array | no | Array of employee ids |
| from | string | yes | Y-m-d |
| to | string | yes | Y-m-d |
| limit | integer | no | Limit employees |
| page | integer | no | Request a specific page |

### List Vacation Configurations
`GET https://www.apizie.tech/v1/finance:sesame-hr/vacation-configurations-list-configurations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List Vacation Calendars
`GET https://www.apizie.tech/v1/finance:sesame-hr/vacation-calendars-list-calendars` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | Employee ID |
| year[in] | array | no | Year calendar |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create Vacation Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/vacation-calendars-create-new-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update Vacation Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/vacation-calendars-update-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Calendar ID |
| body | object | yes | JSON request body |

### List Vacation Day Off
`GET https://www.apizie.tech/v1/finance:sesame-hr/vacation-day-off-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds | array | no | The id of the employees |
| from | string | no | First day of search period |
| to | string | no | Last day of search period |
| page | integer | no | Request a specific page |
| limit | integer | no | Limit vacation requests |
| orderBy | string | no | field1 asc, field2 desc |

### List Vacation Day Off Requests
`GET https://www.apizie.tech/v1/finance:sesame-hr/vacation-day-off-requests-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | The id of the employee |
| absencesValidator | string | no | The id of the manager |
| fromDayOff | string | no | First day of search period |
| toDayOff | string | no | Last day of search period |
| status | string | no | Request status |
| page | integer | no | Request a specific page |
| limit | integer | no | Limit vacation requests |
| orderBy | string | no | field1 asc, field2 desc |

### Create Vacation Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/vacation-day-off-requests-create-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Accept Vacation Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/vacation-day-off-requests-accept-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Day Off Request Id |
| body | object | no | JSON request body |

### Reject Vacation Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/vacation-day-off-requests-reject-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Day Off Request Id |
| body | object | no | JSON request body |

### Delete Vacation Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/vacation-day-off-requests-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Day Off Request Id |

### List Absence Types
`GET https://www.apizie.tech/v1/finance:sesame-hr/absence-types-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List Absence Calendars
`GET https://www.apizie.tech/v1/finance:sesame-hr/absence-calendars-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | Employee ID |
| type | string | no | Absence Type ID |
| year[in] | array | no | Year calendar |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create Absence Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/absence-calendars-create-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update Absence Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/absence-calendars-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Calendar ID |
| body | object | no | JSON request body |

### List Absence Day Off
`GET https://www.apizie.tech/v1/finance:sesame-hr/absence-day-off-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeIds | array | no | The id of the employees |
| from | string | no | First day of search period |
| to | string | no | Last day of search period |
| limit | integer | no | Limit day offs |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### List Absence Day Off Requests
`GET https://www.apizie.tech/v1/finance:sesame-hr/absence-day-off-requests-list-day-off-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | The id of the employee |
| absencesValidator | string | no | The id of the manager |
| fromDayOff | string | no | First day of search period |
| toDayOff | string | no | Last day of search period |
| status | string | no | Request status |
| limit | integer | no | Limit day offs |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### Create Absence Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/absence-day-off-requests-create-day-off-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Accept Absence Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/absence-day-off-requests-accept-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Day Off Request Id |
| body | object | no | JSON request body |

### Reject Absence Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/absence-day-off-requests-reject-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Day Off Request Id |
| body | object | no | JSON request body |

### Delete Absence Day Off Request
`POST https://www.apizie.tech/v1/finance:sesame-hr/absence-day-off-requests-delete-request-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Day Off Request Id |

### List Holidays Calendar
`GET https://www.apizie.tech/v1/finance:sesame-hr/holiday-calendars-list-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |
| name[contains] | string | no | Filter by name |

### Create Holidays Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/holiday-calendars-create-new-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List Holiday Calendar
`GET https://www.apizie.tech/v1/finance:sesame-hr/holiday-calendars-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| holidayCalendarId | string | yes | Holiday Calendar Id |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Update Holidays Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/holiday-calendars-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| holidayCalendarId | string | yes | Holiday Calendar Id |
| body | object | yes | JSON request body |

### Delete Holidays Calendar
`POST https://www.apizie.tech/v1/finance:sesame-hr/holiday-calendars-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| holidayCalendarId | string | yes | Holiday Calendar Id |

### List Holidays
`GET https://www.apizie.tech/v1/finance:sesame-hr/holidays-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | yes | Employee ID |
| year | integer | yes |  |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Get Employees By Holiday Calendar
`GET https://www.apizie.tech/v1/finance:sesame-hr/holidays-get-by-holiday-calendar-employees` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| holidayCalendarId | string | yes | Holiday Calendar Id |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Assign Holiday Calendar To Employee
`POST https://www.apizie.tech/v1/finance:sesame-hr/holidays-assign-to-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| holidayCalendarId | string | yes | Holiday Calendar Id |
| body | object | no | JSON request body |

### Unassign Holiday Calendar To Employee
`POST https://www.apizie.tech/v1/finance:sesame-hr/holidays-unassign-holiday-calendar-to-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| holidayCalendarId | string | yes | Holiday Calendar Id |
| body | object | no | JSON request body |

### List schedule templates
`GET https://www.apizie.tech/v1/finance:sesame-hr/schedule-templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List employee schedule template
`GET https://www.apizie.tech/v1/finance:sesame-hr/employee-schedule-templates-list-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | yes | Employee ID |
| from | string | no |  |
| to | string | no |  |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create employee schedule template
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-schedule-templates-create-employee-schedule-templat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete employee schedule template
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-schedule-templates-unassign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entityScheduleTemplateId | string | yes | Employee schedule template UUID |

### List agreements
`GET https://www.apizie.tech/v1/finance:sesame-hr/agreements-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create an agreement
`POST https://www.apizie.tech/v1/finance:sesame-hr/agreements-create-new-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get agreement
`GET https://www.apizie.tech/v1/finance:sesame-hr/agreements-get-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agreementId | string | yes | Agreement UUID |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Update an agreement
`POST https://www.apizie.tech/v1/finance:sesame-hr/agreements-update-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agreementId | string | yes | Agreement UUID |
| body | object | yes | JSON request body |

### Delete agreement
`POST https://www.apizie.tech/v1/finance:sesame-hr/agreements-delete-agreement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agreementId | string | yes | Agreement UUID |

### Create employee agreement
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-agreements-assign-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete employee agreement
`POST https://www.apizie.tech/v1/finance:sesame-hr/employee-agreements-unassign-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agreementEmployeeId | string | yes | Employee agreement UUID |

### Get contracts by employee
`GET https://www.apizie.tech/v1/finance:sesame-hr/contracts-get-by-employee-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | yes | Employee ID |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create a contract
`POST https://www.apizie.tech/v1/finance:sesame-hr/contracts-create-new-contract` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get contract payrolls
`GET https://www.apizie.tech/v1/finance:sesame-hr/contracts-get-payroll-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| period | string | yes | Salary pay period |
| from | string | yes | Y-m-d |
| to | string | yes | Y-m-d |
| currency | string | yes | Salary currency |
| officeIds[in] | array | no | Office Ids to filter employees belonging to them |
| departmentIds[in] | array | no | Department Ids to filter employees belonging to them |
| employeeStatus[in] | array | no | Employee status |
| limit | integer | no | Limit custom fields |
| page | integer | no | Request a specific page |
| orderBy | string | no | firstName asc |

### Update a contract
`POST https://www.apizie.tech/v1/finance:sesame-hr/contracts-update-contract` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contractId | string | yes | Contract ID |
| body | object | yes | JSON request body |

### Delete a contract
`POST https://www.apizie.tech/v1/finance:sesame-hr/contracts-delete-contract` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contractId | string | yes | Contract ID |

### Get current contract by employeeId
`GET https://www.apizie.tech/v1/finance:sesame-hr/contracts-get-current-contract-by-employee-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | yes | Employee ID |

### List Contribution Groups
`GET https://www.apizie.tech/v1/finance:sesame-hr/salaries-list-contribution-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### List Salaries
`GET https://www.apizie.tech/v1/finance:sesame-hr/salaries-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | yes | Employee ID |
| salaryId | string | no | Salary ID |
| payPeriod | string | no | Pay Period |
| grossSalary | integer | no | Gross Salary |
| payments | integer | no | Payments |
| contributionGroup | string | no | Contribution Group |
| startDate | string | no | Start Date |
| endDate | string | no | End Date |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create Salary
`POST https://www.apizie.tech/v1/finance:sesame-hr/salaries-create-salary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update a salary
`POST https://www.apizie.tech/v1/finance:sesame-hr/salaries-update-salary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| salaryId | string | yes | Salary ID |
| body | object | yes | JSON request body |

### Delete a salary
`POST https://www.apizie.tech/v1/finance:sesame-hr/salaries-delete-salary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| salaryId | string | yes | Salary ID |

### Time Entry In
`POST https://www.apizie.tech/v1/finance:sesame-hr/time-entries-start-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Time Entry Out
`POST https://www.apizie.tech/v1/finance:sesame-hr/time-entries-stop-time-entry-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Time Entries
`GET https://www.apizie.tech/v1/finance:sesame-hr/time-entries-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no |  |
| from | string | no |  |
| to | string | no |  |
| employeeStatus | string | no |  |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Create Time Entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/time-entries-create-new-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update Time Entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/time-entries-update-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Time Entry ID |
| body | object | yes | JSON request body |

### Delete a Time Entry
`POST https://www.apizie.tech/v1/finance:sesame-hr/time-entries-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Time Entry ID |

### List customers
`GET https://www.apizie.tech/v1/finance:sesame-hr/customers-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no |  |
| page | integer | no | Request a specific page |
| orderBy | string | no | field1 asc, field2 desc |

### Create a customer
`POST https://www.apizie.tech/v1/finance:sesame-hr/customers-create-new-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update a customer
`POST https://www.apizie.tech/v1/finance:sesame-hr/customers-update-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Customer ID |
| body | object | yes | JSON request body |

### Delete a customer
`POST https://www.apizie.tech/v1/finance:sesame-hr/customers-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Customer ID |

### List projects
`GET https://www.apizie.tech/v1/finance:sesame-hr/projects-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Company ID |
| page | integer | no | Request a specific page |
| limit | integer | no | Limit results |
| orderBy | string | no | field1 asc, field2 desc |

### Create a project
`POST https://www.apizie.tech/v1/finance:sesame-hr/projects-create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update a project
`POST https://www.apizie.tech/v1/finance:sesame-hr/projects-update-project-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Project ID |
| body | object | yes | JSON request body |

### Delete a project
`POST https://www.apizie.tech/v1/finance:sesame-hr/projects-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Project ID |

### List company directories
`GET https://www.apizie.tech/v1/finance:sesame-hr/documents-list-directories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| employeeId | string | no | Filter directories by employee id |
| parentDirectoryType | string | no | Parent directory type |
| limit | integer | no | Limit results |
| page | integer | no | Request a specific page |

### Upload document
`POST https://www.apizie.tech/v1/finance:sesame-hr/documents-upload-new-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| directoryId | string | yes | Directory UUID |
| body | object | yes | Form fields as a JSON object |

### Get vacancies list
`GET https://www.apizie.tech/v1/finance:sesame-hr/recruitment-list-vacancies` (byok)

### Get a vacancy
`GET https://www.apizie.tech/v1/finance:sesame-hr/recruitment-get-vacancy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Vacancy ID |

### Create a candidate
`POST https://www.apizie.tech/v1/finance:sesame-hr/recruitment-create-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a candidate
`GET https://www.apizie.tech/v1/finance:sesame-hr/recruitment-get-candidate-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Candidate ID |

### Upload candidate document
`POST https://www.apizie.tech/v1/finance:sesame-hr/recruitment-upload-candidate-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Candidate ID |
| body | object | yes | Form fields as a JSON object |

### Update a candidate
`POST https://www.apizie.tech/v1/finance:sesame-hr/recruitment-update-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Candidate ID |
| body | object | yes | JSON request body |

### Get candidate status list
`GET https://www.apizie.tech/v1/finance:sesame-hr/recruitment-get-candidate-status-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vacancyId | string | yes | Vacancy ID |

## Example
```
curl "https://www.apizie.tech/v1/finance:sesame-hr/security-get-token-info" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Sesame HR Sesame Public API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/finance:sesame-hr/security-get-token-info with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Sesame HR Sesame Public API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Sesame HR Sesame Public API itself also needs your own key from api-{region}.sesametime.com.

### Can AI agents use the Sesame HR Sesame Public API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:sesame-hr.

### What is the status of the Sesame HR Sesame Public API API?
Needs your own provider key (bring your own key)