Sign in

v2

latestSwagger 2.02026-08-04108164321.0 KB
ScheduleSeries

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

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.

post/api/ScheduleSeries

Request body

ScheduleSeriesIDsinteger[]

Optional list of specific Schedule Series IDs to retrieve.

UpdatedAfterstring date-time

Filter to records updated after this date-time.

ScheduleStartDateFromstring date-time

Filter series starting on or after this date.

ScheduleStartDateTostring date-time

Filter series starting on or before this date.

ScheduleEndDateFromstring date-time

Filter series ending on or after this date.

ScheduleEndDateTostring date-time

Filter series ending on or before this date.

UserIDinteger

Filter by the scheduled user's ID.

UserEmailstring

Filter by the scheduled user's email address.

TimeSheetCategoryIDinteger

Filter by timesheet category ID.

TimeSheetCategoryNamestring

Filter by exact timesheet category name.

LeaveTypeIDinteger

Filter by leave type ID.

ProjectIDinteger

Filter by project ID.

CompanyIDinteger

Filter by the customer company ID of the associated project.

PageSizeinteger

Number of results per page. Default 20, maximum 1000.

PageNumberinteger

1-based page number. Default 1.

Sortstring

Sort order. Values: DateUpdated, DateCreated (append ' desc' for descending).

Response

Returns schedule series matching the filter criteria.

TotalCountinteger

Total number of records matching the query across all pages.

PageNumberinteger

The current page number (1-based).

PageSizeinteger

The number of records per page.