TheTVDB User info API

The User info API from TheTVDB — 2 operation(s) for user info.

OpenAPI Specification

tvdb-user-info-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: 'Documentation of [TheTVDB](https://thetvdb.com/) API V4. All related information is linked from our [Github repo](https://github.com/thetvdb/v4-api). You might also want to use our [Postman collection] (https://www.getpostman.com/collections/7a9397ce69ff246f74d0)

    ## Authentication

    1. Use the /login endpoint and provide your API key as "apikey". If you have a user-supported key, also provide your subscriber PIN as "pin". Otherwise completely remove "pin" from your call.

    2. Executing this call will provide you with a bearer token, which is valid for 1 month.

    3. Provide your bearer token for subsequent API calls by clicking Authorize below or including in the header of all direct API calls: `Authorization: Bearer [your-token]`


    ## Notes

    1. "score" is a field across almost all entities.  We generate scores for different types of entities in various ways, so no assumptions should be made about the meaning of this value.  It is simply used to hint at relative popularity for sorting purposes.

    '
  title: TVDB API V4 Artwork User info API
  version: 4.7.10
  x-last-validated: '2026-05-30'
  x-spec-source: https://github.com/thetvdb/v4-api/blob/main/docs/swagger.yml
servers:
- url: https://api4.thetvdb.com/v4
  description: TheTVDB v4 API production
security:
- bearerAuth: []
tags:
- name: User info
paths:
  /user:
    get:
      description: returns user info
      operationId: getUserInfo
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/UserInfo'
                  status:
                    type: string
                type: object
              examples:
                GetUserInfo200Example:
                  summary: Default getUserInfo 200 response
                  x-microcks-default: true
                  value:
                    data: null
                    status: Continuing
        '401':
          description: Unauthorized
      tags:
      - User info
      summary: TheTVDB Get User Info
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /user/{id}:
    get:
      description: returns user info by user id
      operationId: getUserInfoById
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: number
        example: 12345
      responses:
        '200':
          description: response
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/UserInfo'
                  status:
                    type: string
                type: object
              examples:
                GetUserInfoById200Example:
                  summary: Default getUserInfoById 200 response
                  x-microcks-default: true
                  value:
                    data: null
                    status: Continuing
        '401':
          description: Unauthorized
      tags:
      - User info
      summary: TheTVDB Get User Info by Id
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UserInfo:
      description: User info record
      type: object
      properties:
        id:
          type: integer
          example: 12345
        language:
          type: string
          example: eng
        name:
          type: string
          example: Example Name
        type:
          type: string
          example: example
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT