peopleByIdExtended

GET /v4/people/:id/extended

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

Caution

There is a known bug in this endpoint that causes it to always return the property translations in the response, regardless of whether the meta query parameter is set.

Parameters

Params	Type	Required	Description
id	string	Yes	The people id
translation	boolean	Optional	Include translation information in the response

Examples

Without translations

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

const client = new TheTVDB('access token');
const data = await client.peopleByIdExtended('312388');

Successful response output

{
  status: 'success',
  data: {
    id: 312388,
    name: 'Chris Pratt',
    image: 'https://artworks.thetvdb.com/banners/person/312388/primary.jpg',
    score: 0,
    nameTranslations: ['eng', 'spa', 'por', 'pt', 'ell', 'pol'],
    // ...
  },
};

Include translations in the response

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

const client = new TheTVDB('access token');
const data = await client.peopleByIdExtended('312388', true);

Successful response output

{
  status: 'success',
  data: {
    id: 312388,
    name: 'Chris Pratt',
    image: 'https://artworks.thetvdb.com/banners/person/312388/primary.jpg',
    score: 0,
    nameTranslations: ['eng', 'spa', 'por', 'pt', 'ell', 'pol'],
    // ...
  },
};