people

GET /v4/people

This method returns a list of people records. For official documentation of the endpoint, please refer to the Swagger documentation.

Parameters

Params	Type	Required	Description
page	string	Optional	Restrict results to a specific page

Examples

Without parameters

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

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

Successful response output

{
  status: 'success',
  data: [
    {
      id: 247831,
      name: 'Michelle Fairley',
      image: 'https://artworks.thetvdb.com/banners/v4/actor/247831/photo/62742718e0819.jpg',
      score: 0,
      // ...
    },
    // ...
  ],
  links: {
    prev: null,
    self: 'https://api4.thetvdb.com/v4/people?page=0',
    next: 'https://api4.thetvdb.com/v4/people?page=1',
    total_items: 1325224,
    page_size: 500,
  },
};

Restricted results to page 2650

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

const client = new TheTVDB('access token');
const data = await client.people('2650');

Successful response output

{
  status: 'success',
  data: [
    {
      id: 9120421,
      name: 'Oda Taylor',
      image: null,
      score: 0,
      // ...
    },
    // ...
  ],
  links: {
    prev: 'https://api4.thetvdb.com/v4/people?page=2649',
    self: 'https://api4.thetvdb.com/v4/people?page=2650',
    next: null,
    total_items: 1325224,
    page_size: 500,
  },
};