*REST API › Objects › Operations*

# Schedule

> Consolidated schedule of a date window.

The consolidated schedule of a date window: projects, orders, tasks, internal services and order services. It is read-only and it is a projection of those entities, not a resource you write. It is bounded by dates and does not paginate. Assignees come out by identifier and name, without contact details. Read it with [`GET /api/v1/schedule`](https://docs.filmo.io/rest-api/endpoint-reference/schedule/get-the-schedule-for-a-range).

Schemas: `ScheduleDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `projects` | object[] | Projects that fall within the window. |
| `projects.id` | string |  |
| `projects.name` | string |  |
| `projects.startDate` | string<date-time> |  |
| `projects.endDate` | string<date-time> |  |
| `projects.status` | string |  |
| `orders` | object[] | Orders that fall within the window. |
| `orders.id` | string |  |
| `orders.orderNumber` | string |  |
| `orders.startDate` | string<date-time> |  |
| `orders.endDate` | string<date-time> |  |
| `orders.status` | string |  |
| `orders.contactName` | string |  |
| `orders.projectName` | string |  |
| `tasks` | object[] | Schedule tasks. Without the contact data of whoever they are assigned to. |
| `tasks.id` | string |  |
| `tasks.title` | string |  |
| `tasks.startDate` | string<date-time> |  |
| `tasks.endDate` | string<date-time> |  |
| `tasks.isAllDay` | boolean |  |
| `tasks.isCompleted` | boolean |  |
| `tasks.type` | string |  |
| `tasks.projectId` | string |  |
| `tasks.assignedStaff` | object[] |  |
| `tasks.assignedStaff.id` | string | Staff member identifier. |
| `tasks.assignedStaff.fullName` | string | Name shown in the schedule. |
| `internalServices` | object[] | Assignments not attached to an order. |
| `internalServices.id` | string |  |
| `internalServices.title` | string |  |
| `internalServices.serviceType` | string |  |
| `internalServices.startDate` | string<date-time> |  |
| `internalServices.endDate` | string<date-time> |  |
| `internalServices.projectName` | string |  |
| `internalServices.qty` | number |  |
| `internalServices.assignedStaff` | object[] |  |
| `internalServices.assignedStaff.id` | string | Staff member identifier. |
| `internalServices.assignedStaff.fullName` | string | Name shown in the schedule. |
| `internalServices.assignedVehicleIds` | string[] |  |
| `orderServices` | object[] | Staff and fleet services attached to an order. |
| `orderServices.orderId` | string |  |
| `orderServices.orderNumber` | string |  |
| `orderServices.serviceName` | string |  |
| `orderServices.serviceType` | string |  |
| `orderServices.startDate` | string<date-time> |  |
| `orderServices.endDate` | string<date-time> |  |
| `orderServices.contactName` | string |  |
| `orderServices.projectName` | string |  |
| `orderServices.qty` | number |  |
| `orderServices.assignedCount` | number |  |
| `orderServices.assignedStaff` | object[] |  |
| `orderServices.assignedStaff.id` | string | Staff member identifier. |
| `orderServices.assignedStaff.fullName` | string | Name shown in the schedule. |

## Example

*Schedule · Generated from the schema*

```json
{
  "projects": [
    {
      "id": "id_8f2a1c",
      "name": "Example",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "status": "string"
    }
  ],
  "orders": [
    {
      "id": "id_8f2a1c",
      "orderNumber": "string",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "status": "string",
      "contactName": "Example",
      "projectName": "Example"
    }
  ],
  "tasks": [
    {
      "id": "id_8f2a1c",
      "title": "Example",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "isAllDay": true,
      "isCompleted": true,
      "type": "string",
      "projectId": "string",
      "assignedStaff": [
        {
          "id": "id_8f2a1c",
          "fullName": "Example"
        }
      ]
    }
  ],
  "internalServices": [
    {
      "id": "id_8f2a1c",
      "title": "Example",
      "serviceType": "string",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "projectName": "Example",
      "qty": 1,
      "assignedStaff": [
        {
          "id": "id_8f2a1c",
          "fullName": "Example"
        }
      ],
      "assignedVehicleIds": [
        "string"
      ]
    }
  ],
  "orderServices": [
    {
      "orderId": "string",
      "orderNumber": "string",
      "serviceName": "Example",
      "serviceType": "string",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "contactName": "Example",
      "projectName": "Example",
      "qty": 1,
      "assignedCount": 1,
      "assignedStaff": [
        {
          "id": "id_8f2a1c",
          "fullName": "Example"
        }
      ]
    }
  ]
}
```

## Returned by

- [`GET /api/v1/schedule`](https://docs.filmo.io/rest-api/endpoint-reference/schedule/get-the-schedule-for-a-range) — Get the schedule for a range

## Modified by

No operation.

---

Canonical URL: https://docs.filmo.io/rest-api/objects/schedule  
Last updated: 2026-10-25