---
title: "Retrieves a paginated list of schedule series matching the provided filter criteria. POST body contains filter parameters."
method: POST
path: "/api/ScheduleSeries"
tags: ["ScheduleSeries"]
---

# Retrieves a paginated list of schedule series matching the provided filter criteria. POST body contains filter parameters.

`POST /api/ScheduleSeries`

Schedule Series represents a strip of time assigned to a user over a date range, for a certain number of hours per day. They can be for Leave or for project work Bookings.

## Request body

- ScheduleSeriesFilterRequest — Request model for filtering schedule series with criteria including date ranges, user, project, and category.
  - `ScheduleSeriesIDs` integer[] — Optional list of specific Schedule Series IDs to retrieve.
  - `UpdatedAfter` string, date-time — Filter to records updated after this date-time.
  - `ScheduleStartDateFrom` string, date-time — Filter series starting on or after this date.
  - `ScheduleStartDateTo` string, date-time — Filter series starting on or before this date.
  - `ScheduleEndDateFrom` string, date-time — Filter series ending on or after this date.
  - `ScheduleEndDateTo` string, date-time — Filter series ending on or before this date.
  - `UserID` integer — Filter by the scheduled user's ID.
  - `UserEmail` string — Filter by the scheduled user's email address.
  - `TimeSheetCategoryID` integer — Filter by timesheet category ID.
  - `TimeSheetCategoryName` string — Filter by exact timesheet category name.
  - `LeaveTypeID` integer — Filter by leave type ID.
  - `ProjectID` integer — Filter by project ID.
  - `CompanyID` integer — Filter by the customer company ID of the associated project.
  - `PageSize` integer — Number of results per page. Default 20, maximum 1000.
  - `PageNumber` integer — 1-based page number. Default 1.
  - `Sort` string — Sort order. Values: DateUpdated, DateCreated (append ' desc' for descending).

## Response `200`

Returns schedule series matching the filter criteria.

- ScheduleSeriesList — Paginated collection of schedule series (bookings and leave).
  - `ScheduleSeries` ScheduleSeriesDetails[] — The list of schedule series records for this page.
    - `ScheduleSeriesID` integer — Unique identifier for the schedule series.
    - `AccountIDFK` integer — The Avaza account this schedule belongs to.
    - `UserIDFK` integer — The user this schedule is assigned to.
    - `Firstname` string — Scheduled user's first name.
    - `Lastname` string — Scheduled user's last name.
    - `ProjectIDFK` integer — The project this booking is for (null for leave).
    - `ProjectTitle` string — Title of the associated project.
    - `CompanyIDFK` integer — The customer company of the associated project.
    - `CompanyName` string — Name of the customer company.
    - `TimeSheetCategoryIDFK` integer — The timesheet category for this booking.
    - `TimeSheetCategoryName` string — Name of the timesheet category.
    - `LeaveTypeIDFK` integer — The leave type ID (for leave schedule entries).
    - `LeaveTypeName` string — Name of the leave type.
    - `StartDate` string, date-time — Start date of the schedule series.
    - `EndDate` string, date-time — End date of the schedule series.
    - `HoursPerDay` number, double — Hours allocated per working day.
    - `TotalDuration` number, double — Total hours across the entire schedule series.
    - `ScheduleOnDaysOff` boolean — Whether to include weekends and holidays in the schedule.
    - `Notes` string — Additional notes on the schedule.
    - `TaskIDFK` integer — The task this booking is linked to, if any.
    - `TaskTitle` string — Title of the associated task.
    - `DateCreated` string, date-time — Date and time the record was created.
    - `DateUpdated` string, date-time — Date and time the record was last updated.
    - `UpdatedByUserIDFK` integer — User ID of the person who last updated this schedule.
    - `StartTime` string — Optional start time of day for the scheduled work.
    - `EndTime` string — Optional end time of day for the scheduled work.
    - `isBillable` boolean — Whether this booking is billable, based on project billing method and category settings.
    - `RateAmount` number, double — The applicable billing rate per hour for this booking.
    - `CostAmount` number, double — The applicable cost rate per hour for this booking.
  - `TotalCount` integer — Total number of records matching the query across all pages.
  - `PageNumber` integer — The current page number (1-based).
  - `PageSize` integer — The number of records per page.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.net/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/versions/1eeadf750514/schema)