---
title: "Read when a playlist item is allowed to display"
method: GET
path: "/api/playlists/items/{item_id}/schedule"
tags: ["Playlists"]
---

# Read when a playlist item is allowed to display

`GET /api/playlists/items/{item_id}/schedule`

## Request

- Base URL: `https://trmnl.com`
- URL: `https://trmnl.com/api/playlists/items/{item_id}/schedule`
- Auth: HTTP bearer

## Path parameters

- `item_id` integer, required

## Response `200`

Reports an item with no windows as always active

- object
  - `data` object
    - `week_schedules` object[]
      - `week_days` integer[]: 0 is Sunday through 6 is Saturday
      - `start_time` string
      - `end_time` string
    - `date_range` object, nullable: Only display between these dates. Null when no dates are set
      - `start_on` string, date, nullable: First day shown. Null for no start
      - `end_on` string, date, nullable: Last day shown. Null for no end
      - `repeats_yearly` boolean: Ignore the years and repeat every year. Needs both dates, and a start after the end runs across the new year
    - `always_active` boolean: True when no window and no dates are set, so the item always displays

## Other responses

- `401`: Unauthorized
- `404`: Playlist item belonging to another user

---

[API](https://skmtc.dev/trmnl/apis/trmnl-api.md) · [All operations](https://skmtc.dev/trmnl/apis/trmnl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trmnl/apis/trmnl-api/revisions/66179e6d663b?raw)