TheTVDB Episodes API

openapi: 3.0.0
info:
  description: 'Documentation of [TheTVDB](https://thetvdb.com/) API V4. All related information is linked from our [Github repo](https://github.com/thetvdb/v4-api). You might also want to use our [Postman collection] (https://www.getpostman.com/collections/7a9397ce69ff246f74d0)

    ## Authentication

    1. Use the /login endpoint and provide your API key as "apikey". If you have a user-supported key, also provide your subscriber PIN as "pin". Otherwise completely remove "pin" from your call.

    2. Executing this call will provide you with a bearer token, which is valid for 1 month.

    3. Provide your bearer token for subsequent API calls by clicking Authorize below or including in the header of all direct API calls: `Authorization: Bearer [your-token]`


    ## Notes

    1. "score" is a field across almost all entities.  We generate scores for different types of entities in various ways, so no assumptions should be made about the meaning of this value.  It is simply used to hint at relative popularity for sorting purposes.

    '
  title: TVDB API V4 Artwork Episodes API
  version: 4.7.10
  x-last-validated: '2026-05-30'
  x-spec-source: https://github.com/thetvdb/v4-api/blob/main/docs/swagger.yml
servers:
- url: https://api4.thetvdb.com/v4
  description: TheTVDB v4 API production
security:
- bearerAuth: []
tags:
- name: Episodes
paths:
  /episodes:
    get:
      description: Returns a list of episodes base records with the basic attributes.<br> Note that all episodes are returned, even those that may not be included in a series' default season order.
      operationId: getAllEpisodes
      parameters:
      - description: page number
        in: query
        name: page
        schema:
          type: number
        example: 1.0
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/EpisodeBaseRecord'
                    type: array
                  status:
                    type: string
                  links:
                    $ref: '#/components/schemas/Links'
                type: object
              examples:
                GetAllEpisodes200Example:
                  summary: Default getAllEpisodes 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - absoluteNumber: 1
                      aired: example
                      airsAfterSeason: 1
                      airsBeforeEpisode: 1
                      airsBeforeSeason: 1
                      finaleType: example
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      imageType: 1
                      isMovie: 12345
                      lastUpdated: '2024-01-15'
                      linkedMovie: 1
                      name: Example Name
                      nameTranslations:
                      - example
                      number: 1
                      overview: A descriptive paragraph of text.
                      overviewTranslations:
                      - example
                      runtime: 1
                      seasonNumber: 1
                      seasons:
                      - id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        lastUpdated: '2024-01-15'
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 12345
                        overviewTranslations:
                        - example
                        companies:
                          studio:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          network:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          production:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          distributor:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          special_effects:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                        seriesId: 12345
                        type:
                          alternateName: example
                          id: 12345
                          name: Example Name
                          type: example
                        year: '2024'
                      seriesId: 12345
                      seasonName: example
                      year: '2024'
                    status: Continuing
                    links:
                      prev: example
                      self: example
                      next: example
                      total_items: 1
                      page_size: 1
        '401':
          description: Unauthorized
      tags:
      - Episodes
      summary: TheTVDB Get All Episodes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /episodes/{id}:
    get:
      description: Returns episode base record
      operationId: getEpisodeBase
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: number
        example: 12345
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/EpisodeBaseRecord'
                  status:
                    type: string
                type: object
              examples:
                GetEpisodeBase200Example:
                  summary: Default getEpisodeBase 200 response
                  x-microcks-default: true
                  value:
                    data:
                      absoluteNumber: 1
                      aired: example
                      airsAfterSeason: 1
                      airsBeforeEpisode: 1
                      airsBeforeSeason: 1
                      finaleType: example
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      imageType: 1
                      isMovie: 12345
                      lastUpdated: '2024-01-15'
                      linkedMovie: 1
                      name: Example Name
                      nameTranslations:
                      - example
                      number: 1
                      overview: A descriptive paragraph of text.
                      overviewTranslations:
                      - example
                      runtime: 1
                      seasonNumber: 1
                      seasons:
                      - id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        lastUpdated: '2024-01-15'
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 12345
                        overviewTranslations:
                        - example
                        companies:
                          studio:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          network:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          production:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          distributor:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          special_effects:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                        seriesId: 12345
                        type:
                          alternateName: example
                          id: 12345
                          name: Example Name
                          type: example
                        year: '2024'
                      seriesId: 12345
                      seasonName: example
                      year: '2024'
                    status: Continuing
        '400':
          description: Invalid episode id
        '401':
          description: Unauthorized
        '404':
          description: Episode not found
      tags:
      - Episodes
      summary: TheTVDB Get Episode Base
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /episodes/{id}/extended:
    get:
      description: Returns episode extended record
      operationId: getEpisodeExtended
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: number
        example: 12345
      - description: meta
        in: query
        name: meta
        required: false
        schema:
          type: string
          enum:
          - translations
          example: translations
        example: translations
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/EpisodeExtendedRecord'
                  status:
                    type: string
                type: object
              examples:
                GetEpisodeExtended200Example:
                  summary: Default getEpisodeExtended 200 response
                  x-microcks-default: true
                  value:
                    data:
                      aired: example
                      airsAfterSeason: 1
                      airsBeforeEpisode: 1
                      airsBeforeSeason: 1
                      awards:
                      - id: 12345
                        name: Example Name
                      characters:
                      - aliases:
                        - language: eng
                          name: Example Name
                        episode:
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          name: Example Name
                          year: '2024'
                        episodeId: 12345
                        id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        isFeatured: true
                        movieId: 12345
                        movie:
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          name: Example Name
                          year: '2024'
                        name: Example Name
                        nameTranslations: &id003
                        - example
                        overviewTranslations: &id004
                        - example
                        peopleId: 12345
                        personImgURL: https://artworks.thetvdb.com/banners/example.jpg
                        peopleType: example
                        seriesId: 12345
                        series:
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          name: Example Name
                          year: '2024'
                        sort: 12345
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                        type: 12345
                        url: https://artworks.thetvdb.com/banners/example.jpg
                        personName: example
                      companies:
                      - activeDate: '2024-01-15'
                        aliases:
                        - language: eng
                          name: Example Name
                        country: usa
                        id: 12345
                        inactiveDate: '2024-01-15'
                        name: Example Name
                        nameTranslations: &id001
                        - example
                        overviewTranslations: &id002
                        - example
                        primaryCompanyType: 12345
                        slug: example-slug
                        parentCompany:
                          id: 12345
                          name: Example Name
                          relation:
                            id: null
                            typeName: null
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                      contentRatings:
                      - id: 12345
                        name: Example Name
                        description: A descriptive paragraph of text.
                        country: usa
                        contentType: example
                        order: 1
                        fullName: example
                      finaleType: example
                      id: 12345
                      image: https://artworks.thetvdb.com/banners/example.jpg
                      imageType: 1
                      isMovie: 12345
                      lastUpdated: '2024-01-15'
                      linkedMovie: 1
                      name: Example Name
                      nameTranslations:
                      - example
                      networks:
                      - activeDate: '2024-01-15'
                        aliases:
                        - language: eng
                          name: Example Name
                        country: usa
                        id: 12345
                        inactiveDate: '2024-01-15'
                        name: Example Name
                        nameTranslations: *id001
                        overviewTranslations: *id002
                        primaryCompanyType: 12345
                        slug: example-slug
                        parentCompany:
                          id: 12345
                          name: Example Name
                          relation:
                            id: null
                            typeName: null
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                      nominations:
                      - character:
                          aliases:
                          - language: null
                            name: null
                          episode:
                            image: null
                            name: null
                            year: null
                          episodeId: 12345
                          id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          isFeatured: true
                          movieId: 12345
                          movie:
                            image: null
                            name: null
                            year: null
                          name: Example Name
                          nameTranslations: *id003
                          overviewTranslations: *id004
                          peopleId: 12345
                          personImgURL: https://artworks.thetvdb.com/banners/example.jpg
                          peopleType: example
                          seriesId: 12345
                          series:
                            image: null
                            name: null
                            year: null
                          sort: 12345
                          tagOptions:
                          - helpText: null
                            id: null
                            name: null
                            tag: null
                            tagName: null
                          type: 12345
                          url: https://artworks.thetvdb.com/banners/example.jpg
                          personName: example
                        details: example
                        episode:
                          absoluteNumber: 1
                          aired: example
                          airsAfterSeason: 1
                          airsBeforeEpisode: 1
                          airsBeforeSeason: 1
                          finaleType: example
                          id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          imageType: 1
                          isMovie: 12345
                          lastUpdated: '2024-01-15'
                          linkedMovie: 1
                          name: Example Name
                          nameTranslations:
                          - example
                          number: 1
                          overview: A descriptive paragraph of text.
                          overviewTranslations:
                          - example
                          runtime: 1
                          seasonNumber: 1
                          seasons:
                          - id: null
                            image: null
                            imageType: null
                            lastUpdated: null
                            name: null
                            nameTranslations: null
                            number: null
                            overviewTranslations: null
                            companies: {}
                            seriesId: null
                            type: {}
                            year: null
                          seriesId: 12345
                          seasonName: example
                          year: '2024'
                        id: 12345
                        isWinner: true
                        movie:
                          aliases:
                          - language: null
                            name: null
                          id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          lastUpdated: '2024-01-15'
                          name: Example Name
                          nameTranslations:
                          - example
                          overviewTranslations:
                          - example
                          score: 100
                          slug: example-slug
                          status:
                            id: null
                            keepUpdated: null
                            name: null
                            recordType: null
                          runtime: 1
                          year: '2024'
                        series:
                          aliases:
                          - language: null
                            name: null
                          averageRuntime: 1
                          country: usa
                          defaultSeasonType: 12345
                          episodes:
                          - absoluteNumber: null
                            aired: null
                            airsAfterSeason: null
                            airsBeforeEpisode: null
                            airsBeforeSeason: null
                            finaleType: null
                            id: null
                            image: null
                            imageType: null
                            isMovie: null
                            lastUpdated: null
                            linkedMovie: null
                            name: null
                            nameTranslations: null
                            number: null
                            overview: null
                            overviewTranslations: null
                            runtime: null
                            seasonNumber: null
                            seasons:
                            - {}
                            seriesId: null
                            seasonName: null
                            year: null
                          firstAired: example
                          id: 12345
                          image: https://artworks.thetvdb.com/banners/example.jpg
                          isOrderRandomized: true
                          lastAired: example
                          lastUpdated: '2024-01-15'
                          name: Example Name
                          nameTranslations:
                          - example
                          nextAired: example
                          originalCountry: example
                          originalLanguage: example
                          overviewTranslations:
                          - example
                          score: 100
                          slug: example-slug
                          status:
                            id: null
                            keepUpdated: null
                            name: null
                            recordType: null
                          year: '2024'
                        year: '2024'
                        category: example
                        name: Example Name
                      number: 1
                      overview: A descriptive paragraph of text.
                      overviewTranslations:
                      - example
                      productionCode: example
                      remoteIds:
                      - id: abc123
                        type: 12345
                        sourceName: example
                      runtime: 1
                      seasonNumber: 1
                      seasons:
                      - id: 12345
                        image: https://artworks.thetvdb.com/banners/example.jpg
                        imageType: 1
                        lastUpdated: '2024-01-15'
                        name: Example Name
                        nameTranslations:
                        - example
                        number: 12345
                        overviewTranslations:
                        - example
                        companies:
                          studio:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          network:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          production:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          distributor:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                          special_effects:
                          - activeDate: null
                            aliases:
                            - {}
                            country: null
                            id: null
                            inactiveDate: null
                            name: null
                            nameTranslations: null
                            overviewTranslations: null
                            primaryCompanyType: null
                            slug: null
                            parentCompany: {}
                            tagOptions:
                            - {}
                        seriesId: 12345
                        type:
                          alternateName: example
                          id: 12345
                          name: Example Name
                          type: example
                        year: '2024'
                      seriesId: 12345
                      studios:
                      - activeDate: '2024-01-15'
                        aliases:
                        - language: eng
                          name: Example Name
                        country: usa
                        id: 12345
                        inactiveDate: '2024-01-15'
                        name: Example Name
                        nameTranslations: *id001
                        overviewTranslations: *id002
                        primaryCompanyType: 12345
                        slug: example-slug
                        parentCompany:
                          id: 12345
                          name: Example Name
                          relation:
                            id: null
                            typeName: null
                        tagOptions:
                        - helpText: example
                          id: 12345
                          name: Example Name
                          tag: 12345
                          tagName: example
                      tagOptions:
                      - helpText: example
                        id: 12345
                        name: Example Name
                        tag: 12345
                        tagName: example
                      trailers:
                      - id: 12345
                        language: eng
                     

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/openapi/tvdb-episodes-api-openapi.yml