Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TheTVDB Lists API

The Lists API from TheTVDB — 5 operation(s) for lists.

TheTVDB Lists API is one of 29 APIs that TheTVDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a GitHub repository, and a JSON-LD context.

This API exposes 5 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 4.7.10.

Requests are made against a single base URL, https://api4.thetvdb.com/v4.

5 operations 5 paths 8 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.7.10
Base URL
https://api4.thetvdb.com/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

TheTVDB Lists API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Lists 5
GET
/lists
TheTVDB Get All Lists
getAllLists 1 param → 200401
GET
/lists/{id}
TheTVDB Get List
getList 1 param → 200400401404
GET
/lists/slug/{slug}
TheTVDB Get List by Slug
getListBySlug 1 param → 200400401404
GET
/lists/{id}/extended
TheTVDB Get List Extended
getListExtended 1 param → 200400401404
GET
/lists/{id}/translations/{language}
TheTVDB Get List Translation
getListTranslation 2 params → 200400401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ListBaseRecord (13 properties), ListExtendedRecord (12 properties), Translation (7 properties), TagOption (5 properties). Each schema is shown below with its type and property counts.

TagOption
object
tag option record
5 properties
Translation
object
translation record
7 properties
Entity
object
Entity record
3 properties
Alias
object
An alias model, which can be associated with a series, season, movie, person, or list.
2 properties
RemoteID
object
remote id record
3 properties
ListExtendedRecord
object
extended list record
12 properties
ListBaseRecord
object
base list record
13 properties
Links
object
Links for next, previous and current record
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tvdb-lists-api-openapi.yml Raw ↑

Other APIs TheTVDB publishes across the network.

TheTVDB Artwork API
TheTVDB Artwork Statuses API
TheTVDB Artwork Types API
TheTVDB Award Categories API
TheTVDB Awards API
TheTVDB Characters API
TheTVDB Companies API
TheTVDB Content Ratings API
TheTVDB Countries API
TheTVDB Entity Types API
TheTVDB Episodes API
TheTVDB Favorites API