*REST API › Endpoint reference › Operations › Schedule*

# Get the schedule for a range

> Returns the consolidated schedule of a window: projects, orders, tasks, internal services and order services.

It does not paginate: it is bounded by dates, which is what a calendar asks for, but each layer is capped and the response does not say when it was cut: at most 200 projects, 200 orders and 500 tasks, ordered by start date, so a layer that returns exactly its cap may be truncated (use a shorter window). Only active records appear: projects in `draft`, `budgeted`, `confirmed` or `in_progress`, and orders in `draft`, `reserved`, `prepared_partially`, `prepared`, `picked_up_partially`, `picked_up`, `returned_partially`, `returned` or `checked_in_partially`; a `checked_in`, cancelled or archived order is not returned. It is therefore not a complete snapshot: do not delete a record only because it is missing. Assignees come out by identifier and name; their contact details do not.

`GET /api/v1/schedule` — scope `schedule:read`

Scope: `schedule:read` · 120/min · If-None-Match · MCP: `filmo_schedule_get`

## Authorizations

Bearer API key with the scope below. `schedule:read`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Conditional read: the `ETag` of the copy you already have. If the resource has not changed, the response is `304` with no body. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `startDate` | string<date-time> | Yes | Window start, in ISO 8601 with offset. |
| `endDate` | string<date-time> | Yes | Window end, in ISO 8601 with offset. |
| `layers` | string[] | No | Which layers to fetch: projects, orders, tasks, internal_services or order_services. By default, everything. Repeat the parameter or separate the values with commas for several. `projects`, `orders`, `tasks`, `internal_services`, `order_services` |
| `projectStatus` | string[] | No | Filter projects by status. |
| `orderStatus` | string[] | No | Filter orders by status. |
| `assignedToStaffIds` | string[] | No | Keep only what is assigned to these staff members. |

## Request examples

*Get the schedule for a range*

**cURL**

```bash
curl 'https://app.filmo.io/api/v1/schedule?startDate=2026-09-01T08%3A00%3A00Z&endDate=2026-09-01T08%3A00%3A00Z' \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/schedule?startDate=2026-09-01T08%3A00%3A00Z&endDate=2026-09-01T08%3A00%3A00Z', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/schedule?startDate=2026-09-01T08%3A00%3A00Z&endDate=2026-09-01T08%3A00%3A00Z",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `ScheduleDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 304 | Not modified: the `If-None-Match` sent matches the current `ETag`. No body; the copy you have is current. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Consolidated schedule of a date window. |
| `data.projects` | object[] | Projects that fall within the window. |
| `data.projects.id` | string |  |
| `data.projects.name` | string |  |
| `data.projects.startDate` | string<date-time> |  |
| `data.projects.endDate` | string<date-time> |  |
| `data.projects.status` | string |  |
| `data.orders` | object[] | Orders that fall within the window. |
| `data.orders.id` | string |  |
| `data.orders.orderNumber` | string |  |
| `data.orders.startDate` | string<date-time> |  |
| `data.orders.endDate` | string<date-time> |  |
| `data.orders.status` | string |  |
| `data.orders.contactName` | string |  |
| `data.orders.projectName` | string |  |
| `data.tasks` | object[] | Schedule tasks. Without the contact data of whoever they are assigned to. |
| `data.tasks.id` | string |  |
| `data.tasks.title` | string |  |
| `data.tasks.startDate` | string<date-time> |  |
| `data.tasks.endDate` | string<date-time> |  |
| `data.tasks.isAllDay` | boolean |  |
| `data.tasks.isCompleted` | boolean |  |
| `data.tasks.type` | string |  |
| `data.tasks.projectId` | string |  |
| `data.tasks.assignedStaff` | object[] |  |
| `data.tasks.assignedStaff.id` | string | Staff member identifier. |
| `data.tasks.assignedStaff.fullName` | string | Name shown in the schedule. |
| `data.internalServices` | object[] | Assignments not attached to an order. |
| `data.internalServices.id` | string |  |
| `data.internalServices.title` | string |  |
| `data.internalServices.serviceType` | string |  |
| `data.internalServices.startDate` | string<date-time> |  |
| `data.internalServices.endDate` | string<date-time> |  |
| `data.internalServices.projectName` | string |  |
| `data.internalServices.qty` | number |  |
| `data.internalServices.assignedStaff` | object[] |  |
| `data.internalServices.assignedStaff.id` | string | Staff member identifier. |
| `data.internalServices.assignedStaff.fullName` | string | Name shown in the schedule. |
| `data.internalServices.assignedVehicleIds` | string[] |  |
| `data.orderServices` | object[] | Staff and fleet services attached to an order. |
| `data.orderServices.orderId` | string |  |
| `data.orderServices.orderNumber` | string |  |
| `data.orderServices.serviceName` | string |  |
| `data.orderServices.serviceType` | string |  |
| `data.orderServices.startDate` | string<date-time> |  |
| `data.orderServices.endDate` | string<date-time> |  |
| `data.orderServices.contactName` | string |  |
| `data.orderServices.projectName` | string |  |
| `data.orderServices.qty` | number |  |
| `data.orderServices.assignedCount` | number |  |
| `data.orderServices.assignedStaff` | object[] |  |
| `data.orderServices.assignedStaff.id` | string | Staff member identifier. |
| `data.orderServices.assignedStaff.fullName` | string | Name shown in the schedule. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": {
    "projects": [
      {
        "id": "project_9f3a2b",
        "name": "Example project",
        "startDate": "2026-09-01T08:00:00.000Z",
        "endDate": "2026-09-01T08:00:00.000Z",
        "status": "Example status"
      }
    ],
    "orders": [
      {
        "id": "order_9f3a2b",
        "orderNumber": "2026-0001",
        "startDate": "2026-09-01T08:00:00.000Z",
        "endDate": "2026-09-01T08:00:00.000Z",
        "status": "Example status",
        "contactName": "Example contact name",
        "projectName": "Example project name"
      }
    ],
    "tasks": [
      {
        "id": "task_9f3a2b",
        "title": "Example title",
        "startDate": "2026-09-01T08:00:00.000Z",
        "endDate": "2026-09-01T08:00:00.000Z",
        "isAllDay": true,
        "isCompleted": true,
        "type": "Example type",
        "projectId": "project_9f3a2b",
        "assignedStaff": [
          {
            "id": "assigned_staff_9f3a2b",
            "fullName": "Example full name"
          }
        ]
      }
    ],
    "internalServices": [
      {
        "id": "internal_service_9f3a2b",
        "title": "Example title",
        "serviceType": "Example service type",
        "startDate": "2026-09-01T08:00:00.000Z",
        "endDate": "2026-09-01T08:00:00.000Z",
        "projectName": "Example project name",
        "qty": 1,
        "assignedStaff": [
          {
            "id": "assigned_staff_9f3a2b",
            "fullName": "Example full name"
          }
        ],
        "assignedVehicleIds": [
          "assigned_vehicle_9f3a2b"
        ]
      }
    ],
    "orderServices": [
      {
        "orderId": "order_9f3a2b",
        "orderNumber": "2026-0001",
        "serviceName": "Example service name",
        "serviceType": "Example service type",
        "startDate": "2026-09-01T08:00:00.000Z",
        "endDate": "2026-09-01T08:00:00.000Z",
        "contactName": "Example contact name",
        "projectName": "Example project name",
        "qty": 1,
        "assignedCount": 1,
        "assignedStaff": [
          {
            "id": "assigned_staff_9f3a2b",
            "fullName": "Example full name"
          }
        ]
      }
    ]
  }
}
```

304: No body.

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/schedule/get-the-schedule-for-a-range  
Last updated: 2026-10-25