# List all available episodes Collects all episodes from the specified tenant's content library with optional filtering. This endpoint retrieves episodes from the content repository based on the provided tenant ID and applies any specified filters. It performs a search against the playout exporter configurations to find matching episodes and verifies their availability in the storage. The filtering system supports both exact matching and case-insensitive partial matching when the filter value is prefixed with a tilde (~). Endpoint: GET /playouts/{playoutId}/episodes Version: 2025-09-02 ## Path parameters: - `playoutId` (string, required) The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform. This is typically provided by the service administrator. ## Query parameters: - `provider` (string) Filter the episodes for a specific content provider (e.g., "netflix", "hbo"). Use exact match by default. Prepend a tilde ~ for a case insensitive text search (e.g., "~net" will match "Netflix"). - `movieOrSeries` (string) Filter the episodes for a movie or series name (exact match, prepend a tilde ~ for a case insensitive text match). - `episode` (string) Filter the episodes for a episode name (exact match, prepend a tilde ~ for a case insensitive text match). - `targetDevice` (string) Filter the episodes for a target device name (exact match, prepend a tilde ~ for a case insensitive text match). - `assetId` (string) Filter the episodes for the asset identifier (exact match, prepend a tilde ~ for a case insensitive text match).Since X-API-Version 2025-09-02. - `next_token` (string) The token, which can be used to retrieve the next page of data. Check nextToken in response if another call is required to receive all data.Available since X-API-Version 2025-08-27 ## Header parameters: - `X-API-Key` (string, required) API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key. - `X-JAY-TRACKING` (string) Tracking session header for user tracking and analytics. This is set by the /playouts/{playout_id}/tracking/session endpoint. Example: "eyJzZXNzaW9uX2lkIjoiZXhhbXBsZS1zZXNzaW9uLWlkLTEyMzQiLCJzdGFydF90aW1lIjoiMjAyNS0wMS0wMVQxMjowMDowMC4wMDAwMDAiLCJzb3VyY2UiOiJqYXkuYXBpLnBsYXlvdXQuZXhhbXBsZSJ9" ## Response 200 fields (application/json): - `data` (array) The response data. Example: [{"episodeId":"string","preview":true,"providerName":"string","movieOrSeriesName":"string","episodeName":"string","targetDeviceName":"string","assetId":"string","intro":{"title":"string","subtitle":"string","description":"string","custom1":"string","custom2":"string","custom3":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"language":"string","country":"string"}}] - `data.episodeId` (string, required) The episode identifier used to identify an episode in this API. - `data.preview` (boolean) The episode is in preview and will be not listed when the API is called with the standard (distribution) token. - `data.providerName` (string) the content provider. - `data.movieOrSeriesName` (string) the movie or series name. - `data.episodeName` (string) the episode name. - `data.targetDeviceName` (string) the target device (e.g. "web", "ios", "iostab", "android"). - `data.assetId` (string) The unique external identifier of the project (aka asset identifier). The asset identifier can be directly used as episodeId in the playout API. - `data.intro` (object) The episode introduction. - `data.intro.title` (string) The title of this episode - `data.intro.subtitle` (string) The subtitle of this episode - `data.intro.description` (string) The description of this episode - `data.intro.custom1` (string) The custom field #1 of this episode - `data.intro.custom2` (string) The custom field #2 of this episode - `data.intro.custom3` (string) The custom field #3 of this episode - `data.intro.images` (array) The images related to this episode - `data.intro.images.url` (string) The image URL of this image - `data.intro.images.copyright` (string) The image copyright of this image - `data.intro.links` (array) The links related to this episode - `data.intro.links.url` (string) The link URL of this object - `data.intro.links.urlLabel` (string) The link label of this object - `data.intro.links.urlNote` (string) The link note of this object - `data.intro.links.urlImage` (object) The link image of this object - `data.intro.language` (string) The language of this episode - `data.intro.country` (string) The country of this episode - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details. ## Response 401 fields (application/json): - `data` (array) The response data. Example: [{"episodeId":"string","preview":true,"providerName":"string","movieOrSeriesName":"string","episodeName":"string","targetDeviceName":"string","assetId":"string","intro":{"title":"string","subtitle":"string","description":"string","custom1":"string","custom2":"string","custom3":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"language":"string","country":"string"}}] - `data.episodeId` (string, required) The episode identifier used to identify an episode in this API. - `data.preview` (boolean) The episode is in preview and will be not listed when the API is called with the standard (distribution) token. - `data.providerName` (string) the content provider. - `data.movieOrSeriesName` (string) the movie or series name. - `data.episodeName` (string) the episode name. - `data.targetDeviceName` (string) the target device (e.g. "web", "ios", "iostab", "android"). - `data.assetId` (string) The unique external identifier of the project (aka asset identifier). The asset identifier can be directly used as episodeId in the playout API. - `data.intro` (object) The episode introduction. - `data.intro.title` (string) The title of this episode - `data.intro.subtitle` (string) The subtitle of this episode - `data.intro.description` (string) The description of this episode - `data.intro.custom1` (string) The custom field #1 of this episode - `data.intro.custom2` (string) The custom field #2 of this episode - `data.intro.custom3` (string) The custom field #3 of this episode - `data.intro.images` (array) The images related to this episode - `data.intro.images.url` (string) The image URL of this image - `data.intro.images.copyright` (string) The image copyright of this image - `data.intro.links` (array) The links related to this episode - `data.intro.links.url` (string) The link URL of this object - `data.intro.links.urlLabel` (string) The link label of this object - `data.intro.links.urlNote` (string) The link note of this object - `data.intro.links.urlImage` (object) The link image of this object - `data.intro.language` (string) The language of this episode - `data.intro.country` (string) The country of this episode - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details. ## Response 404 fields (application/json): - `data` (array) The response data. Example: [{"episodeId":"string","preview":true,"providerName":"string","movieOrSeriesName":"string","episodeName":"string","targetDeviceName":"string","assetId":"string","intro":{"title":"string","subtitle":"string","description":"string","custom1":"string","custom2":"string","custom3":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"language":"string","country":"string"}}] - `data.episodeId` (string, required) The episode identifier used to identify an episode in this API. - `data.preview` (boolean) The episode is in preview and will be not listed when the API is called with the standard (distribution) token. - `data.providerName` (string) the content provider. - `data.movieOrSeriesName` (string) the movie or series name. - `data.episodeName` (string) the episode name. - `data.targetDeviceName` (string) the target device (e.g. "web", "ios", "iostab", "android"). - `data.assetId` (string) The unique external identifier of the project (aka asset identifier). The asset identifier can be directly used as episodeId in the playout API. - `data.intro` (object) The episode introduction. - `data.intro.title` (string) The title of this episode - `data.intro.subtitle` (string) The subtitle of this episode - `data.intro.description` (string) The description of this episode - `data.intro.custom1` (string) The custom field #1 of this episode - `data.intro.custom2` (string) The custom field #2 of this episode - `data.intro.custom3` (string) The custom field #3 of this episode - `data.intro.images` (array) The images related to this episode - `data.intro.images.url` (string) The image URL of this image - `data.intro.images.copyright` (string) The image copyright of this image - `data.intro.links` (array) The links related to this episode - `data.intro.links.url` (string) The link URL of this object - `data.intro.links.urlLabel` (string) The link label of this object - `data.intro.links.urlNote` (string) The link note of this object - `data.intro.links.urlImage` (object) The link image of this object - `data.intro.language` (string) The language of this episode - `data.intro.country` (string) The country of this episode - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details. ## Response 422 fields (application/json): - `data` (array) The response data. Example: [{"episodeId":"string","preview":true,"providerName":"string","movieOrSeriesName":"string","episodeName":"string","targetDeviceName":"string","assetId":"string","intro":{"title":"string","subtitle":"string","description":"string","custom1":"string","custom2":"string","custom3":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"language":"string","country":"string"}}] - `data.episodeId` (string, required) The episode identifier used to identify an episode in this API. - `data.preview` (boolean) The episode is in preview and will be not listed when the API is called with the standard (distribution) token. - `data.providerName` (string) the content provider. - `data.movieOrSeriesName` (string) the movie or series name. - `data.episodeName` (string) the episode name. - `data.targetDeviceName` (string) the target device (e.g. "web", "ios", "iostab", "android"). - `data.assetId` (string) The unique external identifier of the project (aka asset identifier). The asset identifier can be directly used as episodeId in the playout API. - `data.intro` (object) The episode introduction. - `data.intro.title` (string) The title of this episode - `data.intro.subtitle` (string) The subtitle of this episode - `data.intro.description` (string) The description of this episode - `data.intro.custom1` (string) The custom field #1 of this episode - `data.intro.custom2` (string) The custom field #2 of this episode - `data.intro.custom3` (string) The custom field #3 of this episode - `data.intro.images` (array) The images related to this episode - `data.intro.images.url` (string) The image URL of this image - `data.intro.images.copyright` (string) The image copyright of this image - `data.intro.links` (array) The links related to this episode - `data.intro.links.url` (string) The link URL of this object - `data.intro.links.urlLabel` (string) The link label of this object - `data.intro.links.urlNote` (string) The link note of this object - `data.intro.links.urlImage` (object) The link image of this object - `data.intro.language` (string) The language of this episode - `data.intro.country` (string) The country of this episode - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details.