companyById

GET /v4/companies/:id

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

Parameters

Params	Type	Required	Description
id	string	Yes	The company id

Example

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

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

Successful response output

{
  status: 'success',
  data: {
    id: 4,
    name: 'Aaj TV',
    slug: 'aaj-tv',
    nameTranslations: ['eng'],
    overviewTranslations: [],
    aliases: [],
    country: 'pak',
    primaryCompanyType: 1,
    activeDate: null,
    inactiveDate: null,
    companyType: {
      companyTypeId: 1,
      companyTypeName: 'Network',
    },
    parentCompany: {
      id: null,
      name: null,
      relation: {
        id: null,
        typeName: null,
      },
    },
    tagOptions: null,
  },
};