Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Films

Gets a list of film entities

Returns a list of film entities along with their related data.

Historical film entities that are no longer playing are not returned by this endpoint.

Licenses Required

  • Vista.Ocapi
get/ocapi/v1/films

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "films": [
    {
      "title": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "synopsis": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "shortSynopsis": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "censorRatingNote": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    }
  ],
  "relatedData": {
    "genres": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "description": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "censorRatings": [
      {
        "classification": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "classificationDescription": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "events": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "shortName": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "description": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ]
  }
}