ZenotiHelp

Use employee APIs

ZTZenoti Docs Team Updated March 7, 2026 2 min readGuide

The employee APIs let you add and manage employee records, schedules, attendance, blockout times, and security roles. Use these APIs to synchronize employee data with HR systems, manage provider schedules, and control access permissions.

For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.


On this page


Before you begin

  • You need a valid API key or access token. See Set up API authentication.
  • Employee management requires appropriate security role permissions.

Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.

Employee CRUD operations

Add an employee

POST /v1/employees

Creates a new employee record with personal information, job details, and preferences.

Retrieve an employee with payroll

GET /v1/employees/{employee_id}

Retrieves full employee details including payroll information.

Update an employee

PUT /v1/employees/{employee_id}

Updates an existing employee's profile, job details, or preferences.

Check-in and attendance

Check in an employee

POST /v1/employees/{employee_id}/check_in

Records an employee check-in at a center.

Check out an employee

POST /v1/employees/{employee_id}/check_out

Records an employee check-out from a center.

Retrieve center attendance

GET /v1/centers/{center_id}/attendance?date={date}

Retrieves attendance records for all employees at a center on a specific date. Returns expected and actual check-in and check-out times for each employee.

Blockout times

Create a blockout time

POST /v1/employees/{employee_id}/blockouttimes

Creates a blockout time for an employee, preventing bookings during that period.

List blockout times

GET /v1/employees/{employee_id}/blockouttimes

Retrieves all blockout times for an employee.

Note: Center-level blockout times for all employees and rooms can be retrieved using the List All Blockout Times of a Center endpoint. See Use center APIs.

Security roles

List all roles

GET /v1/security_roles

Retrieves all security roles defined for the organization.

Retrieve a role

GET /v1/security_roles/{role_id}

Retrieves details of a specific security role, including its permissions.

Tips

  • Use employee check-in and check-out data to track actual versus expected hours for payroll integration.
  • Blockout times prevent bookings during employee breaks, training, or time off. Always create blockout times before publishing schedules to external booking channels.
  • Security roles control what data and actions are available to each employee. Review role assignments when setting up API authorization groups.

API reference

Was this article helpful?
Your feedback helps us improve our documentation.