listByIdExtended

GET /v4/lists/:id/extended

This method returns a single extended list record. For official documentation of the endpoint, please refer to the Swagger documentation.

Parameters

Params	Type	Required	Description
id	string	Yes	The list id

Example

import { TheTVDB } from '@untidy/thetvdb';

const client = new TheTVDB('access token');
const data = await client.listByIdExtended('1');

Successful response output

{
  status: 'success',
  data: {
    id: 1,
    name: 'Scooby-Doo',
    overview:
      'The following is a list of the various media from the Scooby-Doo franchise which includes series, films and specials.',
    url: '1001',
    isOfficial: false,
    nameTranslations: ['eng'],
    overviewTranslations: ['eng'],
    // ...
  },
};