Get

[POST] .../v1/workschedule/get

Returns a list of work schedules. Use this method to list work schedules before assigning them to users or groups, configuring intervals or selecting the account default schedule. The response returns paginated WorkSchedule rows with schedule type, active/default flags, check-in tolerance settings, optional allowed IP/CIDR values, next_offset and total; the request body is required and supports ids/search/active fields plus the OpenAPI filter metadata for the same query surface. The caller must have work schedule select permission 689 and limit/offset are normalized by the server. Missing body, denied permission, invalid filters, cache or database failures and unavailable account schema features are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of returned items.
offset Int32 Optional Result set offset.
search String Optional Search by name.

Filterable Fields

Field Type Description
active bool Activity filter.
id int Schedule ID array.
name string

Request Example

{
  "filters": [
    {
      "Field": "id",
      "Operator": "In",
      "Value": "14"
    },
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Front desk"
    },
    {
      "Field": "active",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of WorkSchedule Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 14,
      "name": "Front desk weekly schedule",
      "schedule_type": "Weekly",
      "is_account_default": false,
      "check_in_early_sec": 900,
      "check_in_late_sec": 600,
      "check_in_allowed_ips": [
        "203.0.113.10",
        "192.168.1.0/24"
      ],
      "active": true,
      "deleted": false,
      "created_user_id": 5,
      "last_update": 1772527200
    }
  ],
  "next_offset": 0,
  "total": 1
}