TheTVDB · JSON Structure

Tvdb Character Structure

character record

Type: object Properties: 21
EntertainmentMoviesTelevisionMedia MetadataPublic APIsVideo

Character is a JSON Structure definition published by TheTVDB, describing 21 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

aliases episode episodeId id image isFeatured movieId movie name nameTranslations overviewTranslations peopleId personImgURL peopleType seriesId series sort tagOptions type url personName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/json-structure/tvdb-character-structure.json",
  "name": "Character",
  "description": "character record",
  "properties": {
    "aliases": {
      "items": {
        "description": "An alias model, which can be associated with a series, season, movie, person, or list.",
        "properties": {
          "language": {
            "type": "string",
            "maximum": 4,
            "description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
            "example": "eng"
          },
          "name": {
            "type": "string",
            "maximum": 100,
            "description": "A string containing the alias itself.",
            "example": "Example Name"
          }
        },
        "type": "object"
      },
      "type": "array",
      "x-go-name": "Aliases"
    },
    "episode": {
      "description": "base record info",
      "properties": {
        "image": {
          "type": "string",
          "x-go-name": "Image",
          "example": "https://artworks.thetvdb.com/banners/example.jpg"
        },
        "name": {
          "type": "string",
          "x-go-name": "Name",
          "example": "Example Name"
        },
        "year": {
          "type": "string",
          "example": "2024"
        }
      },
      "type": "object",
      "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
    },
    "episodeId": {
      "type": "int32",
      "nullable": true,
      "example": 12345
    },
    "id": {
      "type": "int64",
      "x-go-name": "ID",
      "example": 12345
    },
    "image": {
      "type": "string",
      "example": "https://artworks.thetvdb.com/banners/example.jpg"
    },
    "isFeatured": {
      "type": "boolean",
      "x-go-name": "IsFeatured",
      "example": true
    },
    "movieId": {
      "type": "int32",
      "nullable": true,
      "example": 12345
    },
    "movie": {
      "description": "base record info",
      "properties": {
        "image": {
          "type": "string",
          "x-go-name": "Image",
          "example": "https://artworks.thetvdb.com/banners/example.jpg"
        },
        "name": {
          "type": "string",
          "x-go-name": "Name",
          "example": "Example Name"
        },
        "year": {
          "type": "string",
          "example": "2024"
        }
      },
      "type": "object",
      "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
    },
    "name": {
      "type": "string",
      "example": "Example Name"
    },
    "nameTranslations": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "NameTranslations",
      "example": [
        "example"
      ]
    },
    "overviewTranslations": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "OverviewTranslations",
      "example": [
        "example"
      ]
    },
    "peopleId": {
      "type": "int32",
      "example": 12345
    },
    "personImgURL": {
      "type": "string",
      "example": "https://artworks.thetvdb.com/banners/example.jpg"
    },
    "peopleType": {
      "type": "string",
      "example": "example"
    },
    "seriesId": {
      "type": "int32",
      "nullable": true,
      "example": 12345
    },
    "series": {
      "description": "base record info",
      "properties": {
        "image": {
          "type": "string",
          "x-go-name": "Image",
          "example": "https://artworks.thetvdb.com/banners/example.jpg"
        },
        "name": {
          "type": "string",
          "x-go-name": "Name",
          "example": "Example Name"
        },
        "year": {
          "type": "string",
          "example": "2024"
        }
      },
      "type": "object",
      "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
    },
    "sort": {
      "type": "int64",
      "x-go-name": "Sort",
      "example": 12345
    },
    "tagOptions": {
      "items": {
        "description": "tag option record",
        "properties": {
          "helpText": {
            "type": "string",
            "example": "example"
          },
          "id": {
            "type": "int64",
            "x-go-name": "ID",
            "example": 12345
          },
          "name": {
            "type": "string",
            "x-go-name": "Name",
            "example": "Example Name"
          },
          "tag": {
            "type": "int64",
            "x-go-name": "Tag",
            "example": 12345
          },
          "tagName": {
            "type": "string",
            "x-go-name": "TagName",
            "example": "example"
          }
        },
        "type": "object",
        "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
      },
      "type": "array",
      "x-go-name": "TagOptions"
    },
    "type": {
      "type": "int64",
      "x-go-name": "Type",
      "example": 12345
    },
    "url": {
      "type": "string",
      "x-go-name": "URL",
      "example": "https://artworks.thetvdb.com/banners/example.jpg"
    },
    "personName": {
      "type": "string",
      "example": "example"
    }
  },
  "type": "object"
}