GET episodes

art19.com

Summary: Get a list of episodes
Operation ID: —
Auth: api_key
Description

One initial filter must be provided (`ids`, `series_id`, or `season_id`), otherwise a `400 Bad Request` response will be returned. Additional filters are allowed. This API will only return episodes that your credential has permission to access, which may not be exclusive to your account, depending on the filter(s) being used. Be careful to filter the results as needed.

Parameters (14)

ids[] (array, query, optional)

The list of IDs to filter by. Repeat this parameter for each ID you want to include in the filter. The brackets *MUST* be percent-encoded, per the requirements in [RFC 3986 § 3.4](https://tools.ietf.org/html/rfc3986#section-3.4).

included_in_inventory_calendar (string, query, optional)

Limit the result to episodes usable with an inventory management calendar for the provided AdDeal ID.

month (string, query, optional)

Limit the result to episodes released in this month.

page[number] (integer, query, required)

Select which page number to receive results for. Pages are numbered starting at 1.

Constraints: {'minimum': 1}

page[size] (integer, query, required)

Indicate how many records to return per page. The maximum is 100.

Constraints: {'minimum': 1, 'maximum': 100}

published (boolean, query, optional)

If `true`, limit the result to published episodes only. If `false`, limit the result to _unpublished_ episodes only.

q (string, query, optional)

Limit the result to episodes with a title containing this parameter in a case-insensitive way.

released_after (string, query, optional)

Limit the result to episodes released after this timestamp.

released_before (string, query, optional)

Limit the result to episodes released before this timestamp.

rss (boolean, query, optional)

If `true`, limit the result to published and released episodes holding an available media file. If this is `true`, it also changes the default sort order to `-released_at`.

season_id (string, query, optional)

Limit result to episodes linked to this season.

series_id (string, query, optional)

Limit the result to episodes linked to this series.

sort (array, query, optional, default: sort_title)

Specify how to sort the result. Please refer to either the top section or the [JSON:API specification](https://jsonapi.org/format/#fetching-sorting) on how sorting works in general.

year (string, query, optional)

Limit the result to episodes released in this year.

No probe data for this endpoint yet.