GetGroups

[POST] .../v1/workscheduleassignment/getgroups

Returns work schedule assignments to groups. List schedule assignments applied to user groups before changing group-level planning or resolving why an employee received a schedule. The response returns paginated WorkGroupSchedule rows with group_id, schedule_id, date range, priority, active flag, created_user_id, last_update, next_offset and total; the request body is required and supports group_ids, date, limit and offset fields plus the OpenAPI filter metadata for the same query surface. The caller must have work schedule assignment select permission 693 and higher priority group assignments are returned first by the ordering. Missing body, denied permission, invalid date filters and storage errors are returned as HTTP 200 ErrorResult.

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.

Filterable Fields

Field Type Description
date string Filter date in YYYY-MM-DD format.
group_id int Group IDs.

Request Example

{
  "filters": [
    {
      "Field": "group_id",
      "Operator": "In",
      "Value": "3"
    },
    {
      "Field": "date",
      "Operator": "Equal",
      "Value": "2026-03-01"
    }
  ],
  "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 WorkGroupSchedule Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 31,
      "group_id": 3,
      "schedule_id": 14,
      "date_from": "2026-03-01",
      "date_to": null,
      "priority": 10,
      "active": true,
      "created_user_id": 5,
      "last_update": 1772527200
    }
  ],
  "next_offset": 0,
  "total": 1
}