Get episodes

Use this action to retrieve all episodes for a specific series. It’s useful for displaying episode details, tracking watched status, or building episode lists.

This action returns its result in a response variable, which you can use in later steps of the same automation or script.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get the episodes for a series from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Sonarr: Get episodes.
6. Select the Sonarr entry to query, enter the Series ID, and optionally a Season number to filter by.
7. In the Response variable field, enter a name to store the data in, such as episodes_data.
8. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as sonarr.get_episodes. Store the result in a response variable so you can use it in later steps:

action: sonarr.get_episodes
data:
  entry_id: "01234567890abcdef1234567890abcde"
  series_id: 19
  season_number: 1
response_variable: episodes_data

This fetches the episodes of season 1 for the series with ID 19.

Options in YAML

Response data

The response contains an episodes key with a mapping of episodes keyed by episode identifier, for example S01E01. Each episode includes the following fields:

• id: Internal episode ID.
• series_id: Internal Sonarr series ID.
• tvdb_id: Episode TheTVDB ID.
• season_number: Season number.
• episode_number: Episode number.
• episode_identifier: Formatted identifier, such as S01E01.
• title: Episode title.
• air_date: Air date in local time.
• air_date_utc: Air date in UTC.
• overview: Episode overview or description, if available.
• has_file: Whether the episode file exists.
• monitored: Whether the episode is monitored.
• runtime: Episode runtime in minutes.
• episode_file_id: ID of the episode file, or 0 if no file exists.
• finale_type: Finale type, if applicable, such as series or season.

A shortened example of the response looks like this:

episodes:
  "S01E01":
    id: 1001
    series_id: 19
    tvdb_id: 8765432
    season_number: 1
    episode_number: 1
    episode_identifier: "S01E01"
    title: "1923"
    air_date: "2022-12-18 00:00:00"
    air_date_utc: "2022-12-18 05:00:00+00:00"
    overview: "The Dutton family's origin story begins in 1883..."
    has_file: true
    monitored: true
    runtime: 60
    episode_file_id: 5001

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Get series: Retrieves all series in your Sonarr library with their details and statistics.

• Get upcoming: Retrieves upcoming episodes from the Sonarr calendar.

• Get wanted: Retrieves wanted (missing) episodes that Sonarr is searching for.