Check-out an employee

POST https://api.zenoti.com/v1/employees/{employee_id}/checkout

This API helps you to check-out an employee.

You must specify the unique identifier of the employee as employee_id in the API request.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

POST /v1/employees/{employee_id}/checkout

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
employee_id string Yes Mandatory Unique 32-character identifier of the employee.

Response

Success (201 Created)

{
  "is_employee_checked_out": true,
  "check_out_time": "14:34:46"
}

Response fields

Field Type Description
is_employee_checked_out boolean
check_out_time string

Example

curl --request POST \
  --url 'https://api.zenoti.com/v1/employees/{employee_id}/checkout' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/employees/{employee_id}/checkout', {
  method: 'POST',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.post(
    'https://api.zenoti.com/v1/employees/{employee_id}/checkout',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PostAsync(
    "https://api.zenoti.com/v1/employees/{employee_id}/checkout");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/employees/{employee_id}/checkout')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
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