v1

Swagger 2.02026-07-13107162315.5 KB
ScheduleSeries

Gets list of Schedule Series

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.

get/api/ScheduleSeries

Query parameters

UpdatedAfterstring date-time

Limit results to records updated after the specified date

ScheduleStartDateFromstring date-time

Filter for schedules that start on or after a specific date

ScheduleStartDateTostring date-time

Filter for schedules that start on or before a specific date

ScheduleEndDateFromstring date-time

Filter for schedules that end on or after a specific date

ScheduleEndDateTostring date-time

Filter for schedules that end on or before a specific date

UserIDinteger

The UserID of a schedule user to filter assignments for. Only api users with Admin role can see all schedules across all users. Users with ScheduleUser role can access their own ScheduleSeries.

UserEmailstring

The email of the user who has been scheduled

TimeSheetCategoryIDinteger

Filter for schedule records linked to a specific timesheeet category

TimeSheetCategoryNamestring

Filter for schedule records with a specific timesheeet category name (exact string match)

LeaveTypeIDinteger

Filter to records of a particular leave type

ProjectIDinteger

Filter to only include books linked to a specific project

CompanyIDinteger

Filter to only include records linked to projects, where that project belongs to a specific customer company

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

Sortstring

Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"

Response

Returns a paginated list of schedule series (bookings and leave).

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.