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 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: [] paths: /login: post: summary: TheTVDB Create an Auth Token. the Token Has One Month Validation Length. operationId: login tags: - Login requestBody: content: application/json: schema: type: object required: - apikey properties: apikey: type: string pin: type: string examples: LoginRequestExample: summary: Default login request x-microcks-default: true value: apikey: YOUR_API_KEY pin: A1B2C3D4 required: true responses: '200': description: response content: application/json: schema: properties: data: properties: token: type: string type: object status: type: string type: object examples: Login200Example: summary: Default login 200 response x-microcks-default: true value: data: token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature status: Continuing '401': description: invalid credentials x-microcks-operation: delay: 0 dispatcher: FALLBACK '/artwork/{id}': get: description: Returns a single artwork base record. operationId: getArtworkBase 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/ArtworkBaseRecord' status: type: string type: object examples: GetArtworkBase200Example: summary: Default getArtworkBase 200 response x-microcks-default: true value: data: height: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg includesText: true language: eng score: 100 thumbnail: example type: 12345 width: 12345 status: Continuing '400': description: Invalid artwork id '401': description: Unauthorized '404': description: Artwork not found tags: - Artwork summary: TheTVDB Get Artwork Base x-microcks-operation: delay: 0 dispatcher: FALLBACK '/artwork/{id}/extended': get: description: Returns a single artwork extended record. operationId: getArtworkExtended 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/ArtworkExtendedRecord' status: type: string type: object examples: GetArtworkExtended200Example: summary: Default getArtworkExtended 200 response x-microcks-default: true value: data: episodeId: 12345 height: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg includesText: true language: eng movieId: 12345 networkId: 12345 peopleId: 12345 score: 100 seasonId: 12345 seriesId: 12345 seriesPeopleId: 12345 status: id: 12345 name: Example Name tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example thumbnail: example thumbnailHeight: 12345 thumbnailWidth: 12345 type: 12345 updatedAt: '2024-01-15' width: 12345 status: Continuing '400': description: Invalid artwork id '401': description: Unauthorized '404': description: Artwork not found tags: - Artwork summary: TheTVDB Get Artwork Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/artwork/statuses': get: description: Returns list of artwork status records. operationId: getAllArtworkStatuses responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ArtworkStatus' type: array status: type: string type: object examples: GetAllArtworkStatuses200Example: summary: Default getAllArtworkStatuses 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name status: Continuing '401': description: Unauthorized tags: - Artwork Statuses summary: TheTVDB Get All Artwork Statuses x-microcks-operation: delay: 0 dispatcher: FALLBACK '/artwork/types': get: description: Returns a list of artworkType records operationId: getAllArtworkTypes responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ArtworkType' type: array status: type: string type: object examples: GetAllArtworkTypes200Example: summary: Default getAllArtworkTypes 200 response x-microcks-default: true value: data: - height: 12345 id: 12345 imageFormat: example name: Example Name recordType: example slug: example-slug thumbHeight: 12345 thumbWidth: 12345 width: 12345 status: Continuing '401': description: Unauthorized tags: - Artwork Types summary: TheTVDB Get All Artwork Types x-microcks-operation: delay: 0 dispatcher: FALLBACK /awards: get: description: Returns a list of award base records operationId: getAllAwards responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/AwardBaseRecord' type: array status: type: string type: object examples: GetAllAwards200Example: summary: Default getAllAwards 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name status: Continuing '401': description: Unauthorized tags: - Awards summary: TheTVDB Get All Awards x-microcks-operation: delay: 0 dispatcher: FALLBACK '/awards/{id}': get: description: Returns a single award base record operationId: getAward 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/AwardBaseRecord' status: type: string type: object examples: GetAward200Example: summary: Default getAward 200 response x-microcks-default: true value: data: id: 12345 name: Example Name status: Continuing '400': description: Invalid awards id '401': description: Unauthorized '404': description: Awards not found tags: - Awards summary: TheTVDB Get Award x-microcks-operation: delay: 0 dispatcher: FALLBACK '/awards/{id}/extended': get: description: Returns a single award extended record operationId: getAwardExtended 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/AwardExtendedRecord' status: type: string type: object examples: GetAwardExtended200Example: summary: Default getAwardExtended 200 response x-microcks-default: true value: data: categories: - allowCoNominees: true award: id: 12345 name: Example Name forMovies: true forSeries: true id: 12345 name: Example Name id: 12345 name: Example Name score: 100 status: Continuing '400': description: Invalid awards id '401': description: Unauthorized '404': description: Awards not found tags: - Awards summary: TheTVDB Get Award Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/awards/categories/{id}': get: description: Returns a single award category base record operationId: getAwardCategory 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/AwardCategoryBaseRecord' status: type: string type: object examples: GetAwardCategory200Example: summary: Default getAwardCategory 200 response x-microcks-default: true value: data: allowCoNominees: true award: id: 12345 name: Example Name forMovies: true forSeries: true id: 12345 name: Example Name status: Continuing '400': description: Invalid category id '401': description: Unauthorized '404': description: Category not found tags: - Award Categories summary: TheTVDB Get Award Category x-microcks-operation: delay: 0 dispatcher: FALLBACK '/awards/categories/{id}/extended': get: description: Returns a single award category extended record operationId: getAwardCategoryExtended 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/AwardCategoryExtendedRecord' status: type: string type: object examples: GetAwardCategoryExtended200Example: summary: Default getAwardCategoryExtended 200 response x-microcks-default: true value: data: allowCoNominees: true award: id: 12345 name: Example Name forMovies: true forSeries: true id: 12345 name: Example Name nominees: - character: aliases: - language: name: episode: image: name: year: episodeId: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isFeatured: true movieId: 12345 movie: image: name: year: name: Example Name nameTranslations: &id001 - example overviewTranslations: &id002 - example peopleId: 12345 personImgURL: https://artworks.thetvdb.com/banners/example.jpg peopleType: example seriesId: 12345 series: image: name: year: sort: 12345 tagOptions: - helpText: id: name: tag: tagName: 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: &id005 - example number: 1 overview: A descriptive paragraph of text. overviewTranslations: &id006 - example runtime: 1 seasonNumber: 1 seasons: - id: image: imageType: lastUpdated: name: nameTranslations: number: overviewTranslations: companies: {} seriesId: type: {} year: seriesId: 12345 seasonName: example year: '2024' id: 12345 isWinner: true movie: aliases: - language: name: id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: &id009 - example overviewTranslations: &id010 - example score: 100 slug: example-slug status: id: keepUpdated: name: recordType: runtime: 1 year: '2024' series: aliases: - language: name: averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - absoluteNumber: aired: airsAfterSeason: airsBeforeEpisode: airsBeforeSeason: finaleType: id: image: imageType: isMovie: lastUpdated: linkedMovie: name: nameTranslations: number: overview: overviewTranslations: runtime: seasonNumber: seasons: - {} seriesId: seasonName: year: firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: &id011 - example nextAired: example originalCountry: example originalLanguage: example overviewTranslations: &id012 - example score: 100 slug: example-slug status: id: keepUpdated: name: recordType: year: '2024' year: '2024' category: example name: Example Name status: Continuing '400': description: Invalid category id '401': description: Unauthorized '404': description: Category not found tags: - Award Categories summary: TheTVDB Get Award Category Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/characters/{id}': get: description: Returns character base record operationId: getCharacterBase 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/Character' status: type: string type: object examples: GetCharacterBase200Example: summary: Default getCharacterBase 200 response x-microcks-default: true value: data: 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: *id001 overviewTranslations: *id002 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 status: Continuing '400': description: Invalid character id '401': description: Unauthorized '404': description: Character not found tags: - Characters summary: TheTVDB Get Character Base x-microcks-operation: delay: 0 dispatcher: FALLBACK /companies: get: description: returns a paginated list of company records operationId: getAllCompanies parameters: - description: name in: query name: page schema: type: number example: 1.0 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Company' type: array status: type: string links: $ref: '#/components/schemas/Links' type: object examples: GetAllCompanies200Example: summary: Default getAllCompanies 200 response x-microcks-default: true value: data: - activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: &id003 - example overviewTranslations: &id004 - example primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: 12345 typeName: example tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '401': description: Unauthorized tags: - Companies summary: TheTVDB Get All Companies x-microcks-operation: delay: 0 dispatcher: FALLBACK '/companies/types': get: description: returns all company type records operationId: getCompanyTypes responses: '200': description: response content: application/json: schema: properties: data: type: array items: $ref: '#/components/schemas/CompanyType' status: type: string type: object examples: GetCompanyTypes200Example: summary: Default getCompanyTypes 200 response x-microcks-default: true value: data: - companyTypeId: 12345 companyTypeName: example status: Continuing '401': description: Unauthorized tags: - Companies summary: TheTVDB Get Company Types x-microcks-operation: delay: 0 dispatcher: FALLBACK '/companies/{id}': get: description: returns a company record operationId: getCompany 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/Company' status: type: string type: object examples: GetCompany200Example: summary: Default getCompany 200 response x-microcks-default: true value: data: activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: 12345 typeName: example tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example status: Continuing '400': description: Invalid company id '401': description: Unauthorized '404': description: Company not found tags: - Companies summary: TheTVDB Get Company x-microcks-operation: delay: 0 dispatcher: FALLBACK /content/ratings: get: description: returns list content rating records operationId: getAllContentRatings responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ContentRating' type: array status: type: string type: object examples: GetAllContentRatings200Example: summary: Default getAllContentRatings 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name description: A descriptive paragraph of text. country: usa contentType: example order: 1 fullName: example status: Continuing '401': description: Unauthorized tags: - Content Ratings summary: TheTVDB Get All Content Ratings x-microcks-operation: delay: 0 dispatcher: FALLBACK /countries: get: description: returns list of country records operationId: getAllCountries responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Country' type: array status: type: string type: object examples: GetAllCountries200Example: summary: Default getAllCountries 200 response x-microcks-default: true value: data: - id: abc123 name: Example Name shortCode: example status: Continuing tags: - Countries summary: TheTVDB Get All Countries x-microcks-operation: delay: 0 dispatcher: FALLBACK '/entities': get: description: returns the active entity types operationId: getEntityTypes responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/EntityType' type: array status: type: string type: object examples: GetEntityTypes200Example: summary: Default getEntityTypes 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name hasSpecials: true status: Continuing '401': description: Unauthorized tags: - Entity Types summary: TheTVDB Get Entity Types x-microcks-operation: delay: 0 dispatcher: FALLBACK '/episodes': get: description: Returns a list of episodes base records with the basic attributes.
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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: &id007 - example number: 12345 overviewTranslations: &id008 - example companies: studio: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} network: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} production: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} distributor: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} special_effects: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} network: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} production: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} distributor: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} special_effects: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: 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: *id001 overviewTranslations: *id002 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: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: 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: &id021 - example networks: - activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example nominations: - character: aliases: - language: name: episode: image: name: year: episodeId: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isFeatured: true movieId: 12345 movie: image: name: year: name: Example Name nameTranslations: *id001 overviewTranslations: *id002 peopleId: 12345 personImgURL: https://artworks.thetvdb.com/banners/example.jpg peopleType: example seriesId: 12345 series: image: name: year: sort: 12345 tagOptions: - helpText: id: name: tag: tagName: 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 runtime: 1 seasonNumber: 1 seasons: - id: image: imageType: lastUpdated: name: nameTranslations: number: overviewTranslations: companies: {} seriesId: type: {} year: seriesId: 12345 seasonName: example year: '2024' id: 12345 isWinner: true movie: aliases: - language: name: id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id009 overviewTranslations: *id010 score: 100 slug: example-slug status: id: keepUpdated: name: recordType: runtime: 1 year: '2024' series: aliases: - language: name: averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - absoluteNumber: aired: airsAfterSeason: airsBeforeEpisode: airsBeforeSeason: finaleType: id: image: imageType: isMovie: lastUpdated: linkedMovie: name: nameTranslations: number: overview: overviewTranslations: runtime: seasonNumber: seasons: - {} seriesId: seasonName: year: firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: keepUpdated: name: recordType: year: '2024' year: '2024' category: example name: Example Name number: 1 overview: A descriptive paragraph of text. overviewTranslations: &id022 - 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} network: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} production: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} distributor: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} special_effects: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: 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: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: 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 name: Example Name url: https://artworks.thetvdb.com/banners/example.jpg runtime: 1 translations: nameTranslations: - aliases: &id013 - example isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example overviewTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example alias: &id016 - example year: '2024' status: Continuing '400': description: Invalid episode id '401': description: Unauthorized '404': description: Episode not found tags: - Episodes summary: TheTVDB Get Episode Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/episodes/{id}/translations/{language}': get: description: Returns episode translation record operationId: getEpisodeTranslation parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: language in: path name: language required: true schema: type: string example: eng responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/Translation' status: type: string type: object examples: GetEpisodeTranslation200Example: summary: Default getEpisodeTranslation 200 response x-microcks-default: true value: data: aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example status: Continuing '400': description: Invalid episode id. Invalid language. '401': description: Unauthorized '404': description: Episode not found tags: - Episodes summary: TheTVDB Get Episode Translation x-microcks-operation: delay: 0 dispatcher: FALLBACK /genders: get: description: returns list of gender records operationId: getAllGenders responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Gender' type: array status: type: string type: object examples: GetAllGenders200Example: summary: Default getAllGenders 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name status: Continuing tags: - Genders summary: TheTVDB Get All Genders x-microcks-operation: delay: 0 dispatcher: FALLBACK /genres: get: description: returns list of genre records operationId: getAllGenres responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GenreBaseRecord' type: array status: type: string type: object examples: GetAllGenres200Example: summary: Default getAllGenres 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name slug: example-slug status: Continuing '401': description: Unauthorized tags: - Genres summary: TheTVDB Get All Genres x-microcks-operation: delay: 0 dispatcher: FALLBACK '/genres/{id}': get: description: Returns genre record operationId: getGenreBase 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/GenreBaseRecord' status: type: string type: object examples: GetGenreBase200Example: summary: Default getGenreBase 200 response x-microcks-default: true value: data: id: 12345 name: Example Name slug: example-slug status: Continuing '400': description: Invalid genre id '401': description: Unauthorized '404': description: Genre not found tags: - Genres summary: TheTVDB Get Genre Base x-microcks-operation: delay: 0 dispatcher: FALLBACK /inspiration/types: get: description: returns list of inspiration types records operationId: getAllInspirationTypes responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/InspirationType' type: array status: type: string type: object examples: GetAllInspirationTypes200Example: summary: Default getAllInspirationTypes 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name description: A descriptive paragraph of text. reference_name: example url: https://artworks.thetvdb.com/banners/example.jpg status: Continuing '401': description: Unauthorized tags: - InspirationTypes summary: TheTVDB Get All Inspiration Types x-microcks-operation: delay: 0 dispatcher: FALLBACK /languages: get: description: returns list of language records operationId: getAllLanguages responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Language' type: array status: type: string type: object examples: GetAllLanguages200Example: summary: Default getAllLanguages 200 response x-microcks-default: true value: data: - id: abc123 name: Example Name nativeName: example shortCode: example status: Continuing '401': description: Unauthorized tags: - Languages summary: TheTVDB Get All Languages x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists: get: description: returns list of list base records operationId: getAllLists 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/ListBaseRecord' type: array status: type: string links: $ref: '#/components/schemas/Links' examples: GetAllLists200Example: summary: Default getAllLists 200 response x-microcks-default: true value: data: - aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: true isOfficial: true name: Example Name nameTranslations: &id014 - example overview: A descriptive paragraph of text. overviewTranslations: &id015 - example remoteIds: - id: abc123 type: 12345 sourceName: example tags: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example score: 100 url: https://artworks.thetvdb.com/banners/example.jpg status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '401': description: Unauthorized tags: - Lists summary: TheTVDB Get All Lists x-microcks-operation: delay: 0 dispatcher: FALLBACK '/lists/{id}': get: description: returns an list base record operationId: getList 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/ListBaseRecord' status: type: string type: object examples: GetList200Example: summary: Default getList 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: true isOfficial: true name: Example Name nameTranslations: *id014 overview: A descriptive paragraph of text. overviewTranslations: *id015 remoteIds: - id: abc123 type: 12345 sourceName: example tags: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example score: 100 url: https://artworks.thetvdb.com/banners/example.jpg status: Continuing '400': description: Invalid list id '401': description: Unauthorized '404': description: List not found tags: - Lists summary: TheTVDB Get List x-microcks-operation: delay: 0 dispatcher: FALLBACK '/lists/slug/{slug}': get: description: returns an list base record search by slug operationId: getListBySlug parameters: - description: slug in: path name: slug required: true schema: type: string example: example-slug responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/ListBaseRecord' status: type: string type: object examples: GetListBySlug200Example: summary: Default getListBySlug 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: true isOfficial: true name: Example Name nameTranslations: *id014 overview: A descriptive paragraph of text. overviewTranslations: *id015 remoteIds: - id: abc123 type: 12345 sourceName: example tags: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example score: 100 url: https://artworks.thetvdb.com/banners/example.jpg status: Continuing '400': description: Invalid list slug '401': description: Unauthorized '404': description: List not found tags: - Lists summary: TheTVDB Get List by Slug x-microcks-operation: delay: 0 dispatcher: FALLBACK '/lists/{id}/extended': get: description: returns a list extended record operationId: getListExtended 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/ListExtendedRecord' status: type: string type: object examples: GetListExtended200Example: summary: Default getListExtended 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name entities: - movieId: 12345 order: 12345 seriesId: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: true isOfficial: true name: Example Name nameTranslations: &id023 - example overview: A descriptive paragraph of text. overviewTranslations: &id024 - example score: 100 url: https://artworks.thetvdb.com/banners/example.jpg status: Continuing '400': description: Invalid list id '401': description: Unauthorized '404': description: Lists not found tags: - Lists summary: TheTVDB Get List Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/lists/{id}/translations/{language}': get: description: Returns list translation record operationId: getListTranslation parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: language in: path name: language required: true schema: type: string example: eng responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Translation' type: array status: type: string type: object examples: GetListTranslation200Example: summary: Default getListTranslation 200 response x-microcks-default: true value: data: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example status: Continuing '400': description: Invalid lists id '401': description: Unauthorized '404': description: Lists not found tags: - Lists summary: TheTVDB Get List Translation x-microcks-operation: delay: 0 dispatcher: FALLBACK /movies: get: description: returns list of movie base records operationId: getAllMovie 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/MovieBaseRecord' type: array status: type: string links: $ref: '#/components/schemas/Links' type: object examples: GetAllMovie200Example: summary: Default getAllMovie 200 response x-microcks-default: true value: data: - aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id009 overviewTranslations: *id010 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example runtime: 1 year: '2024' status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '401': description: Unauthorized tags: - Movies summary: TheTVDB Get All Movie x-microcks-operation: delay: 0 dispatcher: FALLBACK '/movies/{id}': get: description: Returns movie base record operationId: getMovieBase 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/MovieBaseRecord' status: type: string type: object examples: GetMovieBase200Example: summary: Default getMovieBase 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id009 overviewTranslations: *id010 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example runtime: 1 year: '2024' status: Continuing '400': description: Invalid movie id '401': description: Unauthorized '404': description: Movie not found tags: - Movies summary: TheTVDB Get Movie Base x-microcks-operation: delay: 0 dispatcher: FALLBACK '/movies/{id}/extended': get: description: Returns movie extended record operationId: getMovieExtended 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 - description: reduce the payload and returns the short version of this record without characters, artworks and trailers. in: query name: short required: false schema: type: boolean enum: [true, false] example: true responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/MovieExtendedRecord' status: type: string type: object examples: GetMovieExtended200Example: summary: Default getMovieExtended 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name artworks: - height: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg includesText: true language: eng score: 100 thumbnail: example type: 12345 width: 12345 audioLanguages: &id025 - example awards: - id: 12345 name: Example Name boxOffice: example boxOfficeUS: example budget: example 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: *id001 overviewTranslations: *id002 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: studio: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: network: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: production: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: distributor: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: special_effects: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: contentRatings: - id: 12345 name: Example Name description: A descriptive paragraph of text. country: usa contentType: example order: 1 fullName: example first_release: country: usa date: '2024-01-15' detail: example genres: - id: 12345 name: Example Name slug: example-slug id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg inspirations: - id: 12345 type: example type_name: example url: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' lists: - aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: true isOfficial: true name: Example Name nameTranslations: *id014 overview: A descriptive paragraph of text. overviewTranslations: *id015 remoteIds: - id: abc123 type: 12345 sourceName: example tags: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example score: 100 url: https://artworks.thetvdb.com/banners/example.jpg name: Example Name nameTranslations: &id026 - example originalCountry: example originalLanguage: example overviewTranslations: &id027 - example production_countries: - id: 12345 country: usa name: Example Name releases: - country: usa date: '2024-01-15' detail: example remoteIds: - id: abc123 type: 12345 sourceName: example runtime: 1 score: 100 slug: example-slug spoken_languages: &id028 - example status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example studios: - id: 12345 name: Example Name parentStudio: 1 subtitleLanguages: &id029 - example tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example trailers: - id: 12345 language: eng name: Example Name url: https://artworks.thetvdb.com/banners/example.jpg runtime: 1 translations: nameTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example overviewTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example alias: *id016 year: '2024' status: Continuing '400': description: Invalid movie id '401': description: Unauthorized '404': description: Movie not found tags: - Movies summary: TheTVDB Get Movie Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/movies/filter': get: description: Search movies based on filter parameters operationId: getMoviesFilter parameters: - description: production company in: query name: company required: false schema: type: number example: 1 example: 1 - description: content rating id base on a country in: query name: contentRating required: false schema: type: number example: 245 example: 245 - description: country of origin in: query name: country required: true schema: type: string example: usa example: usa - description: genre in: query name: genre required: false schema: type: number example: 3 enum: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36] example: 3 - description: original language in: query name: lang required: true schema: type: string example: eng example: eng - description: sort by results in: query name: sort required: false schema: type: string enum: [score, firstAired, name] example: score - description: status in: query name: status required: false schema: type: number enum: [1, 2, 3] example: 1 - description: release year in: query name: year required: false schema: type: number example: 2020 example: 2020 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/MovieBaseRecord' type: array status: type: string type: object examples: GetMoviesFilter200Example: summary: Default getMoviesFilter 200 response x-microcks-default: true value: data: - aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id009 overviewTranslations: *id010 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example runtime: 1 year: '2024' status: Continuing '400': description: Invalid format parameter. '401': description: Unauthorized tags: - Movies summary: TheTVDB Get Movies Filter x-microcks-operation: delay: 0 dispatcher: FALLBACK '/movies/slug/{slug}': get: description: Returns movie base record search by slug operationId: getMovieBaseBySlug parameters: - description: slug in: path name: slug required: true schema: type: string example: example-slug responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/MovieBaseRecord' status: type: string type: object examples: GetMovieBaseBySlug200Example: summary: Default getMovieBaseBySlug 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id009 overviewTranslations: *id010 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example runtime: 1 year: '2024' status: Continuing '400': description: Invalid movie slug '401': description: Unauthorized '404': description: Movie not found tags: - Movies summary: TheTVDB Get Movie Base by Slug x-microcks-operation: delay: 0 dispatcher: FALLBACK '/movies/{id}/translations/{language}': get: description: Returns movie translation record operationId: getMovieTranslation parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: language in: path name: language required: true schema: type: string example: eng responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/Translation' status: type: string type: object examples: GetMovieTranslation200Example: summary: Default getMovieTranslation 200 response x-microcks-default: true value: data: aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example status: Continuing '400': description: Invalid movie id, invalid language. '401': description: Unauthorized '404': description: Movie not found tags: - Movies summary: TheTVDB Get Movie Translation x-microcks-operation: delay: 0 dispatcher: FALLBACK /movies/statuses: get: description: returns list of status records operationId: getAllMovieStatuses responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Status' type: array status: type: string type: object examples: GetAllMovieStatuses200Example: summary: Default getAllMovieStatuses 200 response x-microcks-default: true value: data: - id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example status: Continuing '401': description: Unauthorized tags: - Movie Statuses summary: TheTVDB Get All Movie Statuses x-microcks-operation: delay: 0 dispatcher: FALLBACK '/people': get: description: Returns a list of people base records with the basic attributes. operationId: getAllPeople 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/PeopleBaseRecord' type: array status: type: string links: $ref: '#/components/schemas/Links' type: object examples: GetAllPeople200Example: summary: Default getAllPeople 200 response x-microcks-default: true value: data: - aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: &id017 - example overviewTranslations: &id018 - example score: 100 status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '401': description: Unauthorized tags: - People summary: TheTVDB Get All People x-microcks-operation: delay: 0 dispatcher: FALLBACK '/people/{id}': get: description: Returns people base record operationId: getPeopleBase 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/PeopleBaseRecord' status: type: string type: object examples: GetPeopleBase200Example: summary: Default getPeopleBase 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id017 overviewTranslations: *id018 score: 100 status: Continuing '400': description: Invalid people id '401': description: Unauthorized '404': description: People not found tags: - People summary: TheTVDB Get People Base x-microcks-operation: delay: 0 dispatcher: FALLBACK '/people/{id}/extended': get: description: Returns people extended record operationId: getPeopleExtended 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/PeopleExtendedRecord' status: type: string type: object examples: GetPeopleExtended200Example: summary: Default getPeopleExtended 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name awards: - id: 12345 name: Example Name biographies: - biography: example language: eng birth: example birthPlace: example 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: *id001 overviewTranslations: *id002 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 death: example gender: 1 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: &id030 - example overviewTranslations: &id031 - example races: - {} remoteIds: - id: abc123 type: 12345 sourceName: example score: 100 slug: example-slug tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example translations: nameTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example overviewTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example alias: *id016 status: Continuing '400': description: Invalid people id '401': description: Unauthorized '404': description: People not found tags: - People summary: TheTVDB Get People Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/people/{id}/translations/{language}': get: description: Returns people translation record operationId: getPeopleTranslation parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: language in: path name: language required: true schema: type: string example: eng responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/Translation' status: type: string type: object examples: GetPeopleTranslation200Example: summary: Default getPeopleTranslation 200 response x-microcks-default: true value: data: aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example status: Continuing '400': description: Invalid people id, invalid language. '401': description: Unauthorized '404': description: People not found tags: - People summary: TheTVDB Get People Translation x-microcks-operation: delay: 0 dispatcher: FALLBACK /people/types: get: description: returns list of peopleType records operationId: getAllPeopleTypes responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PeopleType' type: array status: type: string type: object examples: GetAllPeopleTypes200Example: summary: Default getAllPeopleTypes 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name status: Continuing tags: - People Types summary: TheTVDB Get All People Types x-microcks-operation: delay: 0 dispatcher: FALLBACK /search: get: description: Our search index includes series, movies, people, and companies. Search is limited to 5k results max. operationId: getSearchResults parameters: - description: The primary search string, which can include the main title for a record including all translations and aliases. in: query name: query schema: type: string example: example - description: Alias of the "query" parameter. Recommend using query instead as this field will eventually be deprecated. in: query name: q schema: type: string example: example - description: Restrict results to a specific entity type. Can be movie, series, person, or company. in: query name: type schema: type: string example: example - description: Restrict results to a specific year. Currently only used for series and movies. in: query name: year schema: type: number example: '2024' - description: Restrict results to a specific company (original network, production company, studio, etc). As an example, "The Walking Dead" would have companies of "AMC", "AMC+", and "Disney+". in: query name: company schema: type: string example: example - description: Restrict results to a specific country of origin. Should contain a 3 character country code. Currently only used for series and movies. in: query name: country schema: type: string example: usa - description: Restrict results to a specific director. Generally only used for movies. Should include the full name of the director, such as "Steven Spielberg". in: query name: director schema: type: string example: example - description: Restrict results to a specific primary language. Should include the 3 character language code. Currently only used for series and movies. in: query name: language schema: type: string example: eng - description: Restrict results to a specific type of company. Should include the full name of the type of company, such as "Production Company". Only used for companies. in: query name: primaryType schema: type: string example: example - description: Restrict results to a specific network. Used for TV and TV movies, and functions the same as the company parameter with more specificity. in: query name: network schema: type: string example: example - description: Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. in: query name: remote_id schema: type: string example: abc123 - description: Offset results. in: query name: offset schema: type: number example: 1.0 - description: Limit results. in: query name: limit schema: type: number example: 1.0 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SearchResult' type: array status: type: string links: $ref: '#/components/schemas/Links' type: object examples: GetSearchResults200Example: summary: Default getSearchResults 200 response x-microcks-default: true value: data: - aliases: &id032 - example companies: &id033 - example companyType: example country: usa director: example first_air_time: example genres: &id034 - example id: abc123 image_url: https://artworks.thetvdb.com/banners/example.jpg name: Example Name is_official: true name_translated: example network: example objectID: abc123 officialList: example overview: A descriptive paragraph of text. overviews: {} overview_translated: &id035 - example poster: example posters: &id036 - example primary_language: example remote_ids: - id: abc123 type: 12345 sourceName: example status: Continuing slug: example-slug studios: &id037 - example title: example thumbnail: example translations: {} translationsWithLang: &id038 - example tvdb_id: abc123 type: example year: '2024' status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '401': description: Unauthorized '400': description: Max results overflow tags: - Search summary: TheTVDB Get Search Results x-microcks-operation: delay: 0 dispatcher: FALLBACK /search/remoteid/{remoteId}: get: description: Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity. operationId: getSearchResultsByRemoteId parameters: - description: Search for a specific remote id. Allows searching for an IMDB or EIDR id, for example. in: path required: true name: remoteId schema: type: string example: abc123 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SearchByRemoteIdResult' type: array status: type: string type: object examples: GetSearchResultsByRemoteId200Example: summary: Default getSearchResultsByRemoteId 200 response x-microcks-default: true value: data: - series: aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 runtime: 1 seasonNumber: 1 seasons: - id: image: imageType: lastUpdated: name: nameTranslations: number: overviewTranslations: companies: {} seriesId: type: {} year: seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' people: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id017 overviewTranslations: *id018 score: 100 movie: aliases: - language: eng name: Example Name id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id009 overviewTranslations: *id010 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example runtime: 1 year: '2024' 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' company: activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example status: Continuing '401': description: Unauthorized tags: - Search summary: TheTVDB Get Search Results by Remote Id x-microcks-operation: delay: 0 dispatcher: FALLBACK /seasons: get: description: returns list of seasons base records operationId: getAllSeasons 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/SeasonBaseRecord' type: array status: type: string type: object examples: GetAllSeasons200Example: summary: Default getAllSeasons 200 response x-microcks-default: true value: data: - id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageType: 1 lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: network: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: production: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: distributor: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: special_effects: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: seriesId: 12345 type: alternateName: example id: 12345 name: Example Name type: example year: '2024' status: Continuing '401': description: Unauthorized tags: - Seasons summary: TheTVDB Get All Seasons x-microcks-operation: delay: 0 dispatcher: FALLBACK '/seasons/{id}': get: description: Returns season base record operationId: getSeasonBase 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/SeasonBaseRecord' status: type: string type: object examples: GetSeasonBase200Example: summary: Default getSeasonBase 200 response x-microcks-default: true value: data: id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageType: 1 lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: network: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: production: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: distributor: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: special_effects: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: seriesId: 12345 type: alternateName: example id: 12345 name: Example Name type: example year: '2024' status: Continuing '400': description: Invalid season id '401': description: Unauthorized '404': description: Season not found tags: - Seasons summary: TheTVDB Get Season Base x-microcks-operation: delay: 0 dispatcher: FALLBACK '/seasons/{id}/extended': get: description: Returns season extended record operationId: getSeasonExtended 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/SeasonExtendedRecord' status: type: string type: object examples: GetSeasonExtended200Example: summary: Default getSeasonExtended 200 response x-microcks-default: true value: data: artwork: - height: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg includesText: true language: eng score: 100 thumbnail: example type: 12345 width: 12345 companies: studio: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: network: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: production: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: distributor: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: special_effects: - activeDate: '2024-01-15' aliases: - language: name: country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: name: relation: {} tagOptions: - helpText: id: name: tag: tagName: episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageType: 1 lastUpdated: '2024-01-15' name: Example Name nameTranslations: &id039 - example number: 12345 overviewTranslations: &id040 - example seriesId: 12345 trailers: - id: 12345 language: eng name: Example Name url: https://artworks.thetvdb.com/banners/example.jpg runtime: 1 type: alternateName: example id: 12345 name: Example Name type: example tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example translations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example year: '2024' status: Continuing '400': description: Invalid seasons id '401': description: Unauthorized '404': description: Season not found tags: - Seasons summary: TheTVDB Get Season Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/seasons/types': get: description: Returns season type records operationId: getSeasonTypes responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SeasonType' type: array status: type: string type: object examples: GetSeasonTypes200Example: summary: Default getSeasonTypes 200 response x-microcks-default: true value: data: - alternateName: example id: 12345 name: Example Name type: example status: Continuing '401': description: Unauthorized tags: - Seasons summary: TheTVDB Get Season Types x-microcks-operation: delay: 0 dispatcher: FALLBACK '/seasons/{id}/translations/{language}': get: description: Returns season translation record operationId: getSeasonTranslation parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: language in: path name: language required: true schema: type: string example: eng responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/Translation' status: type: string type: object examples: GetSeasonTranslation200Example: summary: Default getSeasonTranslation 200 response x-microcks-default: true value: data: aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example status: Continuing '400': description: Invalid season id, language not found. '401': description: Unauthorized '404': description: Season not found tags: - Seasons summary: TheTVDB Get Season Translation x-microcks-operation: delay: 0 dispatcher: FALLBACK /series: get: description: returns list of series base records operationId: getAllSeries 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/SeriesBaseRecord' type: array status: type: string links: $ref: '#/components/schemas/Links' type: object examples: GetAllSeries200Example: summary: Default getAllSeries 200 response x-microcks-default: true value: data: - aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '401': description: Unauthorized tags: - Series summary: TheTVDB Get All Series x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}': get: description: Returns series base record operationId: getSeriesBase 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/SeriesBaseRecord' status: type: string type: object examples: GetSeriesBase200Example: summary: Default getSeriesBase 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' status: Continuing '400': description: Invalid series id '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Base x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}/artworks': get: description: Returns series artworks base on language and type.
Note: Artwork type is an id that can be found using **/artwork/types** endpoint. operationId: getSeriesArtworks parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: lang in: query name: lang required: false schema: type: string example: eng, spa example: eng, spa - description: type in: query name: type required: false schema: type: integer example: 1,2,3 example: 1,2,3 responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/SeriesExtendedRecord' status: type: string type: object examples: GetSeriesArtworks200Example: summary: Default getSeriesArtworks 200 response x-microcks-default: true value: data: abbreviation: example airsDays: friday: true monday: true saturday: true sunday: true thursday: true tuesday: true wednesday: true airsTime: example aliases: - language: eng name: Example Name artworks: - episodeId: 12345 height: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg includesText: true language: eng movieId: 12345 networkId: 12345 peopleId: 12345 score: 100 seasonId: 12345 seriesId: 12345 seriesPeopleId: 12345 status: id: 12345 name: Example Name tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example thumbnail: example thumbnailHeight: 12345 thumbnailWidth: 12345 type: 12345 updatedAt: '2024-01-15' width: 12345 averageRuntime: 1 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: *id001 overviewTranslations: *id002 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 contentRatings: - id: 12345 name: Example Name description: A descriptive paragraph of text. country: usa contentType: example order: 1 fullName: example country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example lists: genres: - id: 12345 name: Example Name slug: example-slug id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: &id019 - example companies: - activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example nextAired: example originalCountry: example originalLanguage: example originalNetwork: activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example overview: A descriptive paragraph of text. latestNetwork: activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example overviewTranslations: &id020 - example remoteIds: - id: abc123 type: 12345 sourceName: example score: 100 seasons: - id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageType: 1 lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} network: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} production: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} distributor: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} special_effects: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} seriesId: 12345 type: alternateName: example id: 12345 name: Example Name type: example year: '2024' seasonTypes: - alternateName: example id: 12345 name: Example Name type: example slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example tags: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example trailers: - id: 12345 language: eng name: Example Name url: https://artworks.thetvdb.com/banners/example.jpg runtime: 1 translations: nameTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example overviewTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example alias: *id016 year: '2024' status: Continuing '400': description: Invalid series id '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Artworks x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}/nextAired': get: description: Returns series base record including the nextAired field.
Note: nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint. operationId: getSeriesNextAired 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/SeriesBaseRecord' status: type: string type: object examples: GetSeriesNextAired200Example: summary: Default getSeriesNextAired 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' status: Continuing '400': description: Invalid series id '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Next Aired x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}/extended': get: description: Returns series extended record operationId: getSeriesExtended 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, episodes] example: translations example: translations - description: reduce the payload and returns the short version of this record without characters and artworks in: query name: short required: false schema: type: boolean enum: [true, false] example: true responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/SeriesExtendedRecord' status: type: string type: object examples: GetSeriesExtended200Example: summary: Default getSeriesExtended 200 response x-microcks-default: true value: data: abbreviation: example airsDays: friday: true monday: true saturday: true sunday: true thursday: true tuesday: true wednesday: true airsTime: example aliases: - language: eng name: Example Name artworks: - episodeId: 12345 height: 12345 id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg includesText: true language: eng movieId: 12345 networkId: 12345 peopleId: 12345 score: 100 seasonId: 12345 seriesId: 12345 seriesPeopleId: 12345 status: id: 12345 name: Example Name tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example thumbnail: example thumbnailHeight: 12345 thumbnailWidth: 12345 type: 12345 updatedAt: '2024-01-15' width: 12345 averageRuntime: 1 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: *id001 overviewTranslations: *id002 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 contentRatings: - id: 12345 name: Example Name description: A descriptive paragraph of text. country: usa contentType: example order: 1 fullName: example country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example lists: genres: - id: 12345 name: Example Name slug: example-slug id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id019 companies: - activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example nextAired: example originalCountry: example originalLanguage: example originalNetwork: activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example overview: A descriptive paragraph of text. latestNetwork: activeDate: '2024-01-15' aliases: - language: eng name: Example Name country: usa id: 12345 inactiveDate: '2024-01-15' name: Example Name nameTranslations: *id003 overviewTranslations: *id004 primaryCompanyType: 12345 slug: example-slug parentCompany: id: 12345 name: Example Name relation: id: typeName: tagOptions: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example overviewTranslations: *id020 remoteIds: - id: abc123 type: 12345 sourceName: example score: 100 seasons: - id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg imageType: 1 lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} network: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} production: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} distributor: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} special_effects: - activeDate: aliases: - {} country: id: inactiveDate: name: nameTranslations: overviewTranslations: primaryCompanyType: slug: parentCompany: {} tagOptions: - {} seriesId: 12345 type: alternateName: example id: 12345 name: Example Name type: example year: '2024' seasonTypes: - alternateName: example id: 12345 name: Example Name type: example slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example tags: - helpText: example id: 12345 name: Example Name tag: 12345 tagName: example trailers: - id: 12345 language: eng name: Example Name url: https://artworks.thetvdb.com/banners/example.jpg runtime: 1 translations: nameTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example overviewTranslations: - aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example alias: *id016 year: '2024' status: Continuing '400': description: Invalid series id '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Extended x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}/episodes/{season-type}': get: description: Returns series episodes from the specified season type, default returns the episodes in the series default season type operationId: getSeriesEpisodes parameters: - in: query name: page required: true schema: type: integer default: 0 example: 1 - description: id in: path name: id required: true schema: type: number example: 12345 - description: season-type in: path name: season-type required: true schema: type: string examples: default: value: default official: value: official dvd: value: dvd absolute: value: absolute alternate: value: alternate regional: value: regional - in: query name: season required: false schema: type: integer default: 0 example: 1 - in: query name: episodeNumber required: false schema: type: integer default: 0 example: 1 - description: airDate of the episode, format is yyyy-mm-dd in: query name: airDate required: false schema: type: string example: '2024-01-15' responses: '200': description: response content: application/json: schema: properties: data: type: object properties: series: $ref: '#/components/schemas/SeriesBaseRecord' episodes: type: array items: $ref: '#/components/schemas/EpisodeBaseRecord' status: type: string type: object examples: GetSeriesEpisodes200Example: summary: Default getSeriesEpisodes 200 response x-microcks-default: true value: data: series: aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 runtime: 1 seasonNumber: 1 seasons: - id: image: imageType: lastUpdated: name: nameTranslations: number: overviewTranslations: companies: {} seriesId: type: {} year: seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' status: Continuing '400': description: Invalid series id, episodeNumber is not null then season must be present '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Episodes x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}/episodes/{season-type}/{lang}': get: description: Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type. operationId: getSeriesSeasonEpisodesTranslated parameters: - in: query name: page required: true schema: type: integer default: 0 example: 1 - description: id in: path name: id required: true schema: type: number example: 12345 - description: season-type in: path name: season-type required: true schema: type: string examples: default: value: default official: value: official dvd: value: dvd absolute: value: absolute alternate: value: alternate regional: value: regional - in: path name: lang required: true schema: type: string example: example responses: '200': description: response content: application/json: schema: properties: data: type: object properties: series: $ref: '#/components/schemas/SeriesBaseRecord' status: type: string type: object examples: GetSeriesSeasonEpisodesTranslated200Example: summary: Default getSeriesSeasonEpisodesTranslated 200 response x-microcks-default: true value: data: series: aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 runtime: 1 seasonNumber: 1 seasons: - id: image: imageType: lastUpdated: name: nameTranslations: number: overviewTranslations: companies: {} seriesId: type: {} year: seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' status: Continuing '400': description: Invalid series id, invalid language. '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Season Episodes Translated x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/filter': get: description: Search series based on filter parameters operationId: getSeriesFilter parameters: - description: production company in: query name: company required: false schema: type: number example: 1 example: 1 - description: content rating id base on a country in: query name: contentRating required: false schema: type: number example: 245 example: 245 - description: country of origin in: query name: country required: true schema: type: string example: usa example: usa - description: Genre id. This id can be found using **/genres** endpoint. in: query name: genre required: false schema: type: number example: 3 enum: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36] example: 3 - description: original language in: query name: lang required: true schema: type: string example: eng example: eng - description: sort by results in: query name: sort required: false schema: type: string enum: [score, firstAired, lastAired, name] example: score - description: sort type ascending or descending in: query name: sortType required: false schema: type: string enum: [asc, desc] example: asc - description: status in: query name: status required: false schema: type: number enum: [1, 2, 3] example: 1 - description: release year in: query name: year required: false schema: type: number example: 2020 example: 2020 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SeriesBaseRecord' type: array type: object examples: GetSeriesFilter200Example: summary: Default getSeriesFilter 200 response x-microcks-default: true value: data: - aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' '400': description: Invalid format parameter. '401': description: Unauthorized tags: - Series summary: TheTVDB Get Series Filter x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/slug/{slug}': get: description: Returns series base record searched by slug operationId: getSeriesBaseBySlug parameters: - description: slug in: path name: slug required: true schema: type: string example: example-slug responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/SeriesBaseRecord' status: type: string type: object examples: GetSeriesBaseBySlug200Example: summary: Default getSeriesBaseBySlug 200 response x-microcks-default: true value: data: aliases: - language: eng name: Example Name averageRuntime: 1 country: usa defaultSeasonType: 12345 episodes: - 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: *id005 number: 1 overview: A descriptive paragraph of text. overviewTranslations: *id006 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: *id007 number: 12345 overviewTranslations: *id008 companies: studio: - {} network: - {} production: - {} distributor: - {} special_effects: - {} seriesId: 12345 type: alternateName: id: name: type: year: '2024' seriesId: 12345 seasonName: example year: '2024' firstAired: example id: 12345 image: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: true lastAired: example lastUpdated: '2024-01-15' name: Example Name nameTranslations: *id011 nextAired: example originalCountry: example originalLanguage: example overviewTranslations: *id012 score: 100 slug: example-slug status: id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example year: '2024' status: Continuing '400': description: Invalid series slug '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Base by Slug x-microcks-operation: delay: 0 dispatcher: FALLBACK '/series/{id}/translations/{language}': get: description: Returns series translation record operationId: getSeriesTranslation parameters: - description: id in: path name: id required: true schema: type: number example: 12345 - description: language in: path name: language required: true schema: type: string example: eng responses: '200': description: response content: application/json: schema: properties: data: $ref: '#/components/schemas/Translation' status: type: string type: object examples: GetSeriesTranslation200Example: summary: Default getSeriesTranslation 200 response x-microcks-default: true value: data: aliases: *id013 isAlias: true isPrimary: true language: eng name: Example Name overview: A descriptive paragraph of text. tagline: example status: Continuing '400': description: Invalid series id, invalid language. '401': description: Unauthorized '404': description: Series not found tags: - Series summary: TheTVDB Get Series Translation x-microcks-operation: delay: 0 dispatcher: FALLBACK /series/statuses: get: description: returns list of status records operationId: getAllSeriesStatuses responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Status' type: array status: type: string type: object examples: GetAllSeriesStatuses200Example: summary: Default getAllSeriesStatuses 200 response x-microcks-default: true value: data: - id: 12345 keepUpdated: '2024-01-15' name: Example Name recordType: example status: Continuing '401': description: Unauthorized tags: - Series Statuses summary: TheTVDB Get All Series Statuses x-microcks-operation: delay: 0 dispatcher: FALLBACK /sources/types: get: description: returns list of sourceType records operationId: getAllSourceTypes responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SourceType' type: array status: type: string type: object examples: GetAllSourceTypes200Example: summary: Default getAllSourceTypes 200 response x-microcks-default: true value: data: - id: 12345 name: Example Name postfix: example prefix: example slug: example-slug sort: 12345 status: Continuing '401': description: Unauthorized tags: - Source Types summary: TheTVDB Get All Source Types x-microcks-operation: delay: 0 dispatcher: FALLBACK /updates: get: description: Returns updated entities. methodInt indicates a created record (1), an updated record (2), or a deleted record (3). If a record is deleted because it was a duplicate of another record, the target record's information is provided in mergeToType and mergeToId. operationId: updates parameters: - in: query name: since required: true schema: type: number example: 1.0 - in: query name: type required: false schema: type: string enum: [artwork, award_nominees, companies, episodes, lists, people, seasons, series, seriespeople, artworktypes, award_categories, awards, company_types, content_ratings, countries, entity_types, genres, languages, movies, movie_genres, movie_status, peopletypes, seasontypes, sourcetypes, tag_options, tags, translatedcharacters, translatedcompanies, translatedepisodes, translatedlists, translatedmovies, translatedpeople, translatedseasons, translatedserierk] example: movies example: movies - in: query name: action required: false schema: type: string enum: [delete, update] example: movies example: movies - description: name in: query name: page schema: type: number example: 1.0 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/EntityUpdate' type: array status: type: string links: $ref: '#/components/schemas/Links' type: object examples: Updates200Example: summary: Default updates 200 response x-microcks-default: true value: data: - entityType: example methodInt: 1 method: example extraInfo: example userId: 12345 recordType: example recordId: 12345 timeStamp: 12345 seriesId: 12345 mergeToId: 12345 mergeToEntityType: example status: Continuing links: prev: example self: example next: example total_items: 1 page_size: 1 '400': description: Invalid since, type param. '401': description: Unauthorized tags: - Updates summary: TheTVDB Updates x-microcks-operation: delay: 0 dispatcher: FALLBACK /user: get: description: returns user info operationId: getUserInfo responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/UserInfo' status: type: string type: object examples: GetUserInfo200Example: summary: Default getUserInfo 200 response x-microcks-default: true value: data: status: Continuing '401': description: Unauthorized tags: - User info summary: TheTVDB Get User Info x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/{id}: get: description: returns user info by user id operationId: getUserInfoById parameters: - description: id in: path name: id required: true schema: type: number example: 12345 responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/UserInfo' status: type: string type: object examples: GetUserInfoById200Example: summary: Default getUserInfoById 200 response x-microcks-default: true value: data: status: Continuing '401': description: Unauthorized tags: - User info summary: TheTVDB Get User Info by Id x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/favorites: get: description: returns user favorites operationId: getUserFavorites responses: '200': description: response content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Favorites' status: type: string type: object examples: GetUserFavorites200Example: summary: Default getUserFavorites 200 response x-microcks-default: true value: data: status: Continuing '401': description: Unauthorized tags: - Favorites summary: TheTVDB Get User Favorites x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: creates a new user favorite operationId: createUserFavorites requestBody: content: application/json: schema: $ref: '#/components/schemas/FavoriteRecord' examples: CreateUserFavoritesRequestExample: summary: Default createUserFavorites request x-microcks-default: true value: series: 1 movie: 1 episode: 1 artwork: 1 people: 1 list: 1 responses: '200': description: Ok '400': description: Bad format '401': description: Unauthorized tags: - Favorites summary: TheTVDB Create User Favorites x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: bearerAuth: # arbitrary name for the security scheme type: http scheme: bearer bearerFormat: JWT schemas: Alias: description: An alias model, which can be associated with a series, season, movie, person, or list. properties: language: type: string maximum: 4 description: A 3-4 character string indicating the language of the alias, as defined in Language. example: eng name: type: string maximum: 100 description: A string containing the alias itself. example: Example Name type: object ArtworkBaseRecord: description: base artwork record properties: height: format: int64 type: integer x-go-name: Height example: 12345 id: type: integer example: 12345 image: type: string x-go-name: Image example: https://artworks.thetvdb.com/banners/example.jpg includesText: type: boolean example: true language: type: string example: eng score: type: number example: 100 thumbnail: type: string x-go-name: Thumbnail example: example type: format: int64 type: integer x-go-name: Type description: The artwork type corresponds to the ids from the /artwork/types endpoint. example: 12345 width: format: int64 type: integer x-go-name: Width example: 12345 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model ArtworkExtendedRecord: description: extended artwork record properties: episodeId: type: integer example: 12345 height: format: int64 type: integer x-go-name: Height example: 12345 id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string x-go-name: Image example: https://artworks.thetvdb.com/banners/example.jpg includesText: type: boolean example: true language: type: string example: eng movieId: type: integer example: 12345 networkId: type: integer example: 12345 peopleId: type: integer example: 12345 score: type: number example: 100 seasonId: type: integer example: 12345 seriesId: type: integer example: 12345 seriesPeopleId: type: integer example: 12345 status: $ref: '#/components/schemas/ArtworkStatus' tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions thumbnail: type: string x-go-name: Thumbnail example: example thumbnailHeight: format: int64 type: integer x-go-name: ThumbnailHeight example: 12345 thumbnailWidth: format: int64 type: integer x-go-name: ThumbnailWidth example: 12345 type: format: int64 type: integer x-go-name: Type description: The artwork type corresponds to the ids from the /artwork/types endpoint. example: 12345 updatedAt: format: int64 type: integer x-go-name: UpdatedAt example: '2024-01-15' width: format: int64 type: integer x-go-name: Width example: 12345 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model ArtworkStatus: description: artwork status record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string example: Example Name type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model ArtworkType: description: artwork type record properties: height: format: int64 type: integer example: 12345 id: format: int64 type: integer x-go-name: ID example: 12345 imageFormat: type: string x-go-name: ImageFormat example: example name: type: string x-go-name: Name example: Example Name recordType: type: string x-go-name: RecordType example: example slug: type: string x-go-name: Slug example: example-slug thumbHeight: format: int64 type: integer x-go-name: ThumbHeight example: 12345 thumbWidth: format: int64 type: integer x-go-name: ThumbWidth example: 12345 width: format: int64 type: integer x-go-name: Width example: 12345 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model AwardBaseRecord: description: base award record properties: id: type: integer example: 12345 name: type: string example: Example Name type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model AwardCategoryBaseRecord: description: base award category record properties: allowCoNominees: type: boolean x-go-name: AllowCoNominees example: true award: $ref: '#/components/schemas/AwardBaseRecord' forMovies: type: boolean x-go-name: ForMovies example: true forSeries: type: boolean x-go-name: ForSeries example: true id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string example: Example Name type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model AwardCategoryExtendedRecord: description: extended award category record properties: allowCoNominees: type: boolean x-go-name: AllowCoNominees example: true award: $ref: '#/components/schemas/AwardBaseRecord' forMovies: type: boolean x-go-name: ForMovies example: true forSeries: type: boolean x-go-name: ForSeries example: true id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string example: Example Name nominees: items: $ref: '#/components/schemas/AwardNomineeBaseRecord' type: array x-go-name: Nominees type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model AwardExtendedRecord: description: extended award record properties: categories: items: $ref: '#/components/schemas/AwardCategoryBaseRecord' type: array x-go-name: Categories id: type: integer example: 12345 name: type: string example: Example Name score: format: int64 type: integer x-go-name: Score example: 100 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model AwardNomineeBaseRecord: description: base award nominee record properties: character: $ref: '#/components/schemas/Character' details: type: string example: example episode: $ref: '#/components/schemas/EpisodeBaseRecord' id: format: int64 type: integer x-go-name: ID example: 12345 isWinner: type: boolean x-go-name: IsWinner example: true movie: $ref: '#/components/schemas/MovieBaseRecord' series: $ref: '#/components/schemas/SeriesBaseRecord' year: type: string example: '2024' category: type: string example: example name: type: string example: Example Name type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Biography: description: biography record properties: biography: type: string x-go-name: Biography example: example language: type: string x-go-name: Language example: eng type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Character: description: character record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases episode: $ref: '#/components/schemas/RecordInfo' episodeId: type: integer nullable: true example: 12345 id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg isFeatured: type: boolean x-go-name: IsFeatured example: true movieId: type: integer nullable: true example: 12345 movie: $ref: '#/components/schemas/RecordInfo' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id001 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id002 peopleId: type: integer example: 12345 personImgURL: type: string example: https://artworks.thetvdb.com/banners/example.jpg peopleType: type: string example: example seriesId: type: integer nullable: true example: 12345 series: $ref: '#/components/schemas/RecordInfo' sort: format: int64 type: integer x-go-name: Sort example: 12345 tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions type: format: int64 type: integer x-go-name: Type example: 12345 url: type: string x-go-name: URL example: https://artworks.thetvdb.com/banners/example.jpg personName: type: string example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Company: description: A company record properties: activeDate: type: string example: '2024-01-15' aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases country: type: string example: usa id: format: int64 type: integer x-go-name: ID example: 12345 inactiveDate: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id003 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id004 primaryCompanyType: format: int64 type: integer x-go-name: PrimaryCompanyType nullable: true example: 12345 slug: type: string x-go-name: Slug example: example-slug parentCompany: type: object $ref: '#/components/schemas/ParentCompany' tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model ParentCompany: description: A parent company record type: object properties: id: type: integer nullable: true example: 12345 name: type: string example: Example Name relation: type: object $ref: '#/components/schemas/CompanyRelationShip' CompanyRelationShip: description: A company relationship properties: id: type: integer nullable: true example: 12345 typeName: type: string example: example CompanyType: description: A company type record type: object properties: companyTypeId: type: integer example: 12345 companyTypeName: type: string example: example ContentRating: description: content rating record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name description: type: string example: A descriptive paragraph of text. country: type: string example: usa contentType: type: string example: example order: type: integer example: 1 fullName: type: string example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Country: description: country record properties: id: type: string x-go-name: ID example: abc123 name: type: string x-go-name: Name example: Example Name shortCode: type: string x-go-name: ShortCode example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Entity: description: Entity record properties: movieId: type: integer example: 12345 order: format: int64 type: integer x-go-name: Order example: 12345 seriesId: type: integer example: 12345 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model EntityType: description: Entity Type record properties: id: type: integer example: 12345 name: type: string x-go-name: Order example: Example Name hasSpecials: type: boolean example: true type: object EntityUpdate: description: entity update record properties: entityType: type: string x-go-name: EnitityType example: example methodInt: type: integer example: 1 method: type: string x-go-name: Method example: example extraInfo: type: string example: example userId: type: integer example: 12345 recordType: type: string example: example recordId: format: int64 type: integer x-go-name: RecordID example: 12345 timeStamp: format: int64 type: integer x-go-name: TimeStamp example: 12345 seriesId: description: Only present for episodes records format: int64 type: integer x-go-name: RecordID example: 12345 mergeToId: format: int64 type: integer example: 12345 mergeToEntityType: type: string example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model EpisodeBaseRecord: description: base episode record properties: absoluteNumber: type: integer example: 1 aired: type: string example: example airsAfterSeason: type: integer example: 1 airsBeforeEpisode: type: integer example: 1 airsBeforeSeason: type: integer example: 1 finaleType: description: season, midseason, or series type: string example: example id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg imageType: type: integer nullable: true example: 1 isMovie: format: int64 type: integer x-go-name: IsMovie example: 12345 lastUpdated: type: string example: '2024-01-15' linkedMovie: type: integer example: 1 name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id005 number: type: integer example: 1 overview: type: string example: A descriptive paragraph of text. overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id006 runtime: type: integer nullable: true example: 1 seasonNumber: type: integer example: 1 seasons: items: $ref: '#/components/schemas/SeasonBaseRecord' type: array x-go-name: Seasons seriesId: format: int64 type: integer x-go-name: SeriesID example: 12345 seasonName: type: string example: example year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model EpisodeExtendedRecord: description: extended episode record properties: aired: type: string example: example airsAfterSeason: type: integer example: 1 airsBeforeEpisode: type: integer example: 1 airsBeforeSeason: type: integer example: 1 awards: items: $ref: '#/components/schemas/AwardBaseRecord' type: array x-go-name: Awards characters: items: $ref: '#/components/schemas/Character' type: array x-go-name: Characters companies: items: $ref: '#/components/schemas/Company' type: array contentRatings: items: $ref: '#/components/schemas/ContentRating' type: array x-go-name: ContentRatings finaleType: description: season, midseason, or series type: string example: example id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg imageType: type: integer nullable: true example: 1 isMovie: format: int64 type: integer x-go-name: IsMovie example: 12345 lastUpdated: type: string example: '2024-01-15' linkedMovie: type: integer example: 1 name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id021 networks: items: $ref: '#/components/schemas/Company' type: array nominations: items: $ref: '#/components/schemas/AwardNomineeBaseRecord' type: array x-go-name: Nominees number: type: integer example: 1 overview: type: string example: A descriptive paragraph of text. overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id022 productionCode: type: string example: example remoteIds: items: $ref: '#/components/schemas/RemoteID' type: array x-go-name: RemoteIDs runtime: type: integer nullable: true example: 1 seasonNumber: type: integer example: 1 seasons: items: $ref: '#/components/schemas/SeasonBaseRecord' type: array x-go-name: Seasons seriesId: format: int64 type: integer x-go-name: SeriesID example: 12345 studios: items: $ref: '#/components/schemas/Company' type: array tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions trailers: items: $ref: '#/components/schemas/Trailer' type: array x-go-name: Trailers translations: $ref: '#/components/schemas/TranslationExtended' year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Favorites: description: User favorites record properties: series: items: type: integer type: array x-go-name: series example: - 1 movies: items: type: integer type: array x-go-name: movies example: - 1 episodes: items: type: integer type: array x-go-name: episodes example: - 1 artwork: items: type: integer type: array x-go-name: artwork example: - 1 people: items: type: integer type: array x-go-name: people example: - 1 lists: items: type: integer type: array x-go-name: list example: - 1 FavoriteRecord: description: Favorites record properties: series: type: integer x-go-name: series example: 1 movie: type: integer x-go-name: movies example: 1 episode: type: integer x-go-name: episodes example: 1 artwork: type: integer x-go-name: artwork example: 1 people: type: integer x-go-name: people example: 1 list: type: integer x-go-name: list example: 1 Gender: description: gender record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model GenreBaseRecord: description: base genre record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name slug: type: string x-go-name: Slug example: example-slug type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Language: description: language record properties: id: type: string x-go-name: ID example: abc123 name: type: string x-go-name: Name example: Example Name nativeName: type: string x-go-name: NativeName example: example shortCode: type: string example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model ListBaseRecord: description: base list record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: type: boolean example: true isOfficial: type: boolean x-go-name: IsOfficial example: true name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id014 overview: type: string example: A descriptive paragraph of text. overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id015 remoteIds: items: $ref: '#/components/schemas/RemoteID' type: array x-go-name: RemoteIDs tags: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions score: type: integer example: 100 url: type: string example: https://artworks.thetvdb.com/banners/example.jpg type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model ListExtendedRecord: description: extended list record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases entities: items: $ref: '#/components/schemas/Entity' type: array x-go-name: Entities id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg imageIsFallback: type: boolean example: true isOfficial: type: boolean x-go-name: IsOfficial example: true name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id023 overview: type: string example: A descriptive paragraph of text. overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id024 score: format: int64 type: integer x-go-name: Score example: 100 url: type: string example: https://artworks.thetvdb.com/banners/example.jpg type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model MovieBaseRecord: description: base movie record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string x-go-name: Image example: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: type: string example: '2024-01-15' name: type: string x-go-name: Name example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id009 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id010 score: format: double type: number x-go-name: Score example: 100 slug: type: string x-go-name: Slug example: example-slug status: $ref: '#/components/schemas/Status' runtime: type: integer nullable: true example: 1 year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model MovieExtendedRecord: description: extended movie record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases artworks: items: $ref: '#/components/schemas/ArtworkBaseRecord' type: array x-go-name: Artworks audioLanguages: items: type: string type: array x-go-name: AudioLanguages example: *id025 awards: items: $ref: '#/components/schemas/AwardBaseRecord' type: array x-go-name: Awards boxOffice: type: string example: example boxOfficeUS: type: string example: example budget: type: string example: example characters: items: $ref: '#/components/schemas/Character' type: array x-go-name: Characters companies: type: object $ref: '#/components/schemas/Companies' contentRatings: items: $ref: '#/components/schemas/ContentRating' type: array first_release: type: object $ref: '#/components/schemas/Release' genres: items: $ref: '#/components/schemas/GenreBaseRecord' type: array x-go-name: Genres id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string x-go-name: Image example: https://artworks.thetvdb.com/banners/example.jpg inspirations: items: $ref: '#/components/schemas/Inspiration' type: array x-go-name: Inspirations lastUpdated: type: string example: '2024-01-15' lists: items: $ref: '#/components/schemas/ListBaseRecord' type: array name: type: string x-go-name: Name example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id026 originalCountry: type: string example: example originalLanguage: type: string example: example overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id027 production_countries: items: $ref: '#/components/schemas/ProductionCountry' type: array x-go-name: ProductionCountries releases: items: $ref: '#/components/schemas/Release' type: array x-go-name: Releases remoteIds: items: $ref: '#/components/schemas/RemoteID' type: array x-go-name: RemoteIDs runtime: type: integer nullable: true example: 1 score: format: double type: number x-go-name: Score example: 100 slug: type: string x-go-name: Slug example: example-slug spoken_languages: items: type: string type: array x-go-name: SpokenLanguages example: *id028 status: $ref: '#/components/schemas/Status' studios: items: $ref: '#/components/schemas/StudioBaseRecord' type: array x-go-name: Studios subtitleLanguages: items: type: string type: array x-go-name: SubtitleLanguages example: *id029 tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions trailers: items: $ref: '#/components/schemas/Trailer' type: array x-go-name: Trailers translations: $ref: '#/components/schemas/TranslationExtended' year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model PeopleBaseRecord: description: base people record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id017 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id018 score: format: int64 type: integer x-go-name: Score example: 100 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model PeopleExtendedRecord: description: extended people record properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases awards: items: $ref: '#/components/schemas/AwardBaseRecord' type: array x-go-name: Awards biographies: items: $ref: '#/components/schemas/Biography' type: array x-go-name: Biographies birth: type: string example: example birthPlace: type: string example: example characters: items: $ref: '#/components/schemas/Character' type: array x-go-name: Characters death: type: string example: example gender: type: integer example: 1 id: format: int64 type: integer x-go-name: ID example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg lastUpdated: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id030 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id031 races: items: $ref: '#/components/schemas/Race' type: array x-go-name: Races remoteIds: items: $ref: '#/components/schemas/RemoteID' type: array x-go-name: RemoteIDs score: format: int64 type: integer x-go-name: Score example: 100 slug: type: string example: example-slug tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions translations: $ref: '#/components/schemas/TranslationExtended' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model PeopleType: description: people type record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Race: description: race record type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model RecordInfo: description: base record info properties: image: type: string x-go-name: Image example: https://artworks.thetvdb.com/banners/example.jpg name: type: string x-go-name: Name example: Example Name year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Release: description: release record properties: country: type: string example: usa date: type: string example: '2024-01-15' detail: type: string example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model RemoteID: description: remote id record properties: id: type: string x-go-name: ID example: abc123 type: format: int64 type: integer x-go-name: Type example: 12345 sourceName: type: string x-go-name: SourceName example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SearchResult: description: search result properties: aliases: items: type: string type: array example: *id032 companies: items: type: string type: array example: *id033 companyType: type: string example: example country: type: string example: usa director: type: string example: example first_air_time: type: string example: example genres: items: type: string type: array example: *id034 id: type: string example: abc123 image_url: type: string example: https://artworks.thetvdb.com/banners/example.jpg name: type: string example: Example Name is_official: type: boolean example: true name_translated: type: string example: example network: type: string example: example objectID: type: string example: abc123 officialList: type: string example: example overview: type: string example: A descriptive paragraph of text. overviews: $ref: '#/components/schemas/TranslationSimple' overview_translated: items: type: string type: array example: *id035 poster: type: string example: example posters: items: type: string type: array example: *id036 primary_language: type: string example: example remote_ids: items: $ref: '#/components/schemas/RemoteID' type: array x-go-name: RemoteIDs status: type: string x-go-name: Status example: Continuing slug: type: string example: example-slug studios: items: type: string type: array example: *id037 title: type: string example: example thumbnail: type: string example: example translations: $ref: '#/components/schemas/TranslationSimple' translationsWithLang: items: type: string type: array example: *id038 tvdb_id: type: string example: abc123 type: type: string example: example year: type: string example: '2024' type: object SearchByRemoteIdResult: description: search by remote reuslt is a base record for a movie, series, people, season or company search result properties: series: type: object $ref: '#/components/schemas/SeriesBaseRecord' people: type: object $ref: '#/components/schemas/PeopleBaseRecord' movie: type: object $ref: '#/components/schemas/MovieBaseRecord' episode: type: object $ref: '#/components/schemas/EpisodeBaseRecord' company: type: object $ref: '#/components/schemas/Company' SeasonBaseRecord: description: season genre record properties: id: type: integer example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg imageType: type: integer example: 1 lastUpdated: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id007 number: format: int64 type: integer x-go-name: Number example: 12345 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id008 companies: type: object $ref: '#/components/schemas/Companies' seriesId: format: int64 type: integer x-go-name: SeriesID example: 12345 type: $ref: '#/components/schemas/SeasonType' year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SeasonExtendedRecord: description: extended season record properties: artwork: items: $ref: '#/components/schemas/ArtworkBaseRecord' type: array x-go-name: Artwork companies: type: object $ref: '#/components/schemas/Companies' episodes: items: $ref: '#/components/schemas/EpisodeBaseRecord' type: array x-go-name: Episodes id: type: integer example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg imageType: type: integer example: 1 lastUpdated: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id039 number: format: int64 type: integer x-go-name: Number example: 12345 overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id040 seriesId: format: int64 type: integer x-go-name: SeriesID example: 12345 trailers: items: $ref: '#/components/schemas/Trailer' type: array x-go-name: Trailers type: $ref: '#/components/schemas/SeasonType' tagOptions: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions translations: items: $ref: '#/components/schemas/Translation' type: array year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SeasonType: description: season type record properties: alternateName: type: string x-go-name: Name example: example id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name type: type: string x-go-name: Type example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SeriesAirsDays: description: A series airs day record properties: friday: type: boolean x-go-name: Friday example: true monday: type: boolean x-go-name: Monday example: true saturday: type: boolean x-go-name: Saturday example: true sunday: type: boolean x-go-name: Sunday example: true thursday: type: boolean x-go-name: Thursday example: true tuesday: type: boolean x-go-name: Tuesday example: true wednesday: type: boolean x-go-name: Wednesday example: true type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SeriesBaseRecord: description: The base record for a series. All series airs time like firstAired, lastAired, nextAired, etc. are in US EST for US series, and for all non-US series, the time of the show’s country capital or most populous city. For streaming services, is the official release time. See https://support.thetvdb.com/kb/faq.php?id=29. properties: aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases averageRuntime: type: integer nullable: true example: 1 country: type: string example: usa defaultSeasonType: format: int64 type: integer x-go-name: DefaultSeasonType example: 12345 episodes: items: $ref: '#/components/schemas/EpisodeBaseRecord' type: array x-go-name: Episodes firstAired: type: string example: example id: type: integer example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: type: boolean x-go-name: IsOrderRandomized example: true lastAired: type: string example: example lastUpdated: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id011 nextAired: type: string x-go-name: NextAired example: example originalCountry: type: string example: example originalLanguage: type: string example: example overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id012 score: format: double type: number x-go-name: Score example: 100 slug: type: string example: example-slug status: $ref: '#/components/schemas/Status' year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SeriesExtendedRecord: description: The extended record for a series. All series airs time like firstAired, lastAired, nextAired, etc. are in US EST for US series, and for all non-US series, the time of the show’s country capital or most populous city. For streaming services, is the official release time. See https://support.thetvdb.com/kb/faq.php?id=29. properties: abbreviation: type: string example: example airsDays: $ref: '#/components/schemas/SeriesAirsDays' airsTime: type: string example: example aliases: items: $ref: '#/components/schemas/Alias' type: array x-go-name: Aliases artworks: items: $ref: '#/components/schemas/ArtworkExtendedRecord' type: array x-go-name: Artworks averageRuntime: type: integer nullable: true example: 1 characters: items: $ref: '#/components/schemas/Character' type: array x-go-name: Characters contentRatings: items: $ref: '#/components/schemas/ContentRating' type: array country: type: string example: usa defaultSeasonType: format: int64 type: integer x-go-name: DefaultSeasonType example: 12345 episodes: items: $ref: '#/components/schemas/EpisodeBaseRecord' type: array x-go-name: Episodes firstAired: type: string example: example lists: items: $ref: '#/components/schemas/ListBaseRecord' genres: items: $ref: '#/components/schemas/GenreBaseRecord' type: array x-go-name: Genres id: type: integer example: 12345 image: type: string example: https://artworks.thetvdb.com/banners/example.jpg isOrderRandomized: type: boolean x-go-name: IsOrderRandomized example: true lastAired: type: string example: example lastUpdated: type: string example: '2024-01-15' name: type: string example: Example Name nameTranslations: items: type: string type: array x-go-name: NameTranslations example: *id019 companies: items: $ref: '#/components/schemas/Company' type: array nextAired: type: string x-go-name: NextAired example: example originalCountry: type: string example: example originalLanguage: type: string example: example originalNetwork: $ref: '#/components/schemas/Company' overview: type: string example: A descriptive paragraph of text. latestNetwork: $ref: '#/components/schemas/Company' overviewTranslations: items: type: string type: array x-go-name: OverviewTranslations example: *id020 remoteIds: items: $ref: '#/components/schemas/RemoteID' type: array x-go-name: RemoteIDs score: format: double type: number x-go-name: Score example: 100 seasons: items: $ref: '#/components/schemas/SeasonBaseRecord' type: array x-go-name: Seasons seasonTypes: items: $ref: '#/components/schemas/SeasonType' type: array x-go-name: Seasons slug: type: string example: example-slug status: $ref: '#/components/schemas/Status' tags: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions trailers: items: $ref: '#/components/schemas/Trailer' type: array x-go-name: Trailers translations: $ref: '#/components/schemas/TranslationExtended' year: type: string example: '2024' type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model SourceType: description: source type record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name postfix: type: string example: example prefix: type: string example: example slug: type: string x-go-name: Slug example: example-slug sort: format: int64 type: integer x-go-name: Sort example: 12345 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Status: description: status record properties: id: format: int64 type: integer x-go-name: ID nullable: true example: 12345 keepUpdated: type: boolean x-go-name: KeepUpdated example: '2024-01-15' name: type: string x-go-name: Name example: Example Name recordType: type: string x-go-name: RecordType example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model StudioBaseRecord: description: studio record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name parentStudio: type: integer example: 1 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Tag: description: tag record properties: allowsMultiple: type: boolean x-go-name: AllowsMultiple example: true helpText: type: string example: example id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name options: items: $ref: '#/components/schemas/TagOption' type: array x-go-name: TagOptions type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model TagOption: description: tag option record properties: helpText: type: string example: example id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string x-go-name: Name example: Example Name tag: format: int64 type: integer x-go-name: Tag example: 12345 tagName: type: string x-go-name: TagName example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Trailer: description: trailer record properties: id: format: int64 type: integer x-go-name: ID example: 12345 language: type: string example: eng name: type: string example: Example Name url: type: string example: https://artworks.thetvdb.com/banners/example.jpg runtime: type: integer example: 1 type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model Translation: description: translation record properties: aliases: items: type: string type: array example: *id013 isAlias: type: boolean example: true isPrimary: type: boolean example: true language: type: string x-go-name: Language example: eng name: type: string example: Example Name overview: type: string example: A descriptive paragraph of text. tagline: type: string description: Only populated for movie translations. We disallow taglines without a title. example: example type: object x-go-package: github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model TranslationSimple: description: translation simple record additionalProperties: type: string example: # Ejemplo específico del objeto ara: "تدور قصة المسلسل حول..." ces: "Během letu č. 815 společnosti Oceanic..." deu: "Im Bruchteil einer Sekunde gerät das Leben..." type: object TranslationExtended: description: translation extended record properties: nameTranslations: items: $ref: '#/components/schemas/Translation' type: array overviewTranslations: items: $ref: '#/components/schemas/Translation' type: array alias: items: type: string type: array example: *id016 type: object TagOptionEntity: description: a entity with selected tag option type: object properties: name: type: string example: Example Name tagName: type: string example: example tagId: type: integer example: 12345 UserInfo: description: User info record type: object properties: id: type: integer example: 12345 language: type: string example: eng name: type: string example: Example Name type: type: string example: example Inspiration: description: Movie inspiration record properties: id: format: int64 type: integer x-go-name: ID example: 12345 type: type: string example: example type_name: type: string example: example url: type: string example: https://artworks.thetvdb.com/banners/example.jpg InspirationType: description: Movie inspiration type record properties: id: format: int64 type: integer x-go-name: ID example: 12345 name: type: string example: Example Name description: type: string example: A descriptive paragraph of text. reference_name: type: string example: example url: type: string example: https://artworks.thetvdb.com/banners/example.jpg ProductionCountry: description: Production country record properties: id: format: int64 type: integer x-go-name: ID example: 12345 country: type: string example: usa name: type: string example: Example Name Companies: description: Companies by type record properties: studio: type: array items: $ref: '#/components/schemas/Company' network: type: array items: $ref: '#/components/schemas/Company' production: type: array items: $ref: '#/components/schemas/Company' distributor: type: array items: $ref: '#/components/schemas/Company' special_effects: type: array items: $ref: '#/components/schemas/Company' Links: description: Links for next, previous and current record properties: prev: type: string nullable: true example: example self: type: string nullable: true example: example next: type: string example: example total_items: type: integer example: 1 page_size: type: integer example: 1