v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Task

Query Staffs

You can query schedule staffs (cleaners / operators / receptionists, etc.) by making a request to this endpoint.

get/staffs

offsetinteger

The starting point from which to begin returning results.

limitinteger

The maximum number of results to return. The maximum value is 100.

idinteger

The id of the staff.

is_active0 | 1

Filter staffs by active state. 1: active only, 0: inactive only.

A list of staffs with their details

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

{
  "error_msg": "Done."
}