Skip to Content

VendorServiceStaffApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
addStaffBreakPOST /vendors/{vendor_id}/service-staff/{staff_id}/breaks
addStaffTimeOffPOST /vendors/{vendor_id}/service-staff/{staff_id}/time-off
assignServiceToStaffPOST /vendors/{vendor_id}/service-staff/{staff_id}/services
assignStaffLocationsPOST /vendors/{vendor_id}/service-staff/{staff_id}/locations
createServiceStaffPOST /vendors/{vendor_id}/service-staff
deleteServiceStaffDELETE /vendors/{vendor_id}/service-staff/{staff_id}
getServiceStaffGET /vendors/{vendor_id}/service-staff/{staff_id}
getStaffScheduleGET /vendors/{vendor_id}/service-staff/{staff_id}/schedule
listServiceStaffGET /vendors/{vendor_id}/service-staff
setStaffSchedulePOST /vendors/{vendor_id}/service-staff/{staff_id}/schedule
unassignServiceFromStaffDELETE /vendors/{vendor_id}/service-staff/{staff_id}/services/{service_id}
unassignStaffLocationDELETE /vendors/{vendor_id}/service-staff/{staff_id}/locations/{location_id}
updateServiceStaffPUT /vendors/{vendor_id}/service-staff/{staff_id}

addStaffBreak

MessageResponse addStaffBreak(vendor_id, staff_id, StaffBreakRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
StaffBreakRequestStaffBreakRequest

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

addStaffTimeOff

MessageResponse addStaffTimeOff(vendor_id, staff_id, StaffTimeOffRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
StaffTimeOffRequestStaffTimeOffRequest

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

assignServiceToStaff

MessageResponse assignServiceToStaff(vendor_id, staff_id, AssignServiceRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
AssignServiceRequestAssignServiceRequest

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

assignStaffLocations

MessageResponse assignStaffLocations(vendor_id, staff_id, AssignStaffLocationsRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
AssignStaffLocationsRequestAssignStaffLocationsRequest

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createServiceStaff

VendorServiceStaffResponse createServiceStaff(vendor_id, VendorServiceStaffRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
VendorServiceStaffRequestVendorServiceStaffRequest

Return type

VendorServiceStaffResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

deleteServiceStaff

MessageResponse deleteServiceStaff(vendor_id, staff_id)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getServiceStaff

VendorServiceStaffResponse getServiceStaff(vendor_id, staff_id)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]

Return type

VendorServiceStaffResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getStaffSchedule

List getStaffSchedule(vendor_id, staff_id)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]

Return type

List

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listServiceStaff

List listServiceStaff(vendor_id, is_active, location_id)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
is_activeBoolean[optional] [default to null]
location_idLong[optional] [default to null]

Return type

List

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

setStaffSchedule

List setStaffSchedule(vendor_id, staff_id, StaffScheduleRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
StaffScheduleRequestList

Return type

List

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

unassignServiceFromStaff

MessageResponse unassignServiceFromStaff(vendor_id, staff_id, service_id)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
service_idInteger[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

unassignStaffLocation

MessageResponse unassignStaffLocation(vendor_id, staff_id, location_id)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
location_idLong[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

updateServiceStaff

VendorServiceStaffResponse updateServiceStaff(vendor_id, staff_id, VendorServiceStaffRequest)

Parameters

NameTypeDescriptionNotes
vendor_idLong[default to null]
staff_idInteger[default to null]
VendorServiceStaffRequestVendorServiceStaffRequest

Return type

VendorServiceStaffResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8