Check-in an employee
This API helps you to check-in an employee.
You must specify the unique identifier of the employee as employee_id in the API request.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
POST /v1/employees/{employee_id}/checkin
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployeeId | string | Yes | Mandatory Unique 32-character identifier of the employee. Not required when using biometric check-in (use Guid.Empty instead). |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| Center id | string | No | Mandatory, Unique 32-character identifier of the center where the employee is checking in. |
| fingerprint_data | string | No | Optional, Fingerprint data if biometric is used. Use Guid.Empty instead of employee_id in this case. |
| work_task_id | string | No | Optional. Work task against which check-in is done. |
Response
Success (201 Created)
{
"is_employee_checked_in": true,
"check_in_time": "09:49:19"
}
Response fields
| Field | Type | Description |
|---|---|---|
| is_employee_checked_in | boolean | |
| check_in_time | string |
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/employees/{employee_id}/checkin' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"Center id": "string",
"fingerprint_data": "string",
"work_task_id": "string"
}'
const response = await fetch('https://api.zenoti.com/v1/employees/{employee_id}/checkin', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({ 'Center id': 'string', fingerprint_data: 'string', work_task_id: 'string' })
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/employees/{employee_id}/checkin',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'Center id': 'string', 'fingerprint_data': 'string', 'work_task_id': 'string'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
JsonSerializer.Serialize(new { Center id = "string", fingerprint_data = "string", work_task_id = "string" }),
Encoding.UTF8, "application/json");
var response = await client.PostAsync(
"https://api.zenoti.com/v1/employees/{employee_id}/checkin", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/employees/{employee_id}/checkin')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { Center id: 'string', fingerprint_data: 'string', work_task_id: 'string' }.to_json
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |