---
title: "Gets the current film availability of a particular film"
method: GET
path: "/ocapi/v1/films/{filmId}/availability"
tags: ["Films"]
---

# Gets the current film availability of a particular film

`GET /ocapi/v1/films/{filmId}/availability`

## Request

- Base URL: `https://developer.vista.co` (the document declares no server; this is the origin it was published from)
- URL: `https://developer.vista.co/ocapi/v1/films/{filmId}/availability`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/films/:filmId/availability/get.ts> (a function with typed inputs; its response is checked against the schema)

#### Licenses Required


- Vista.Ocapi

## Path parameters

- `filmId` string, required

## Headers

- `Connect-Region-Code` string

## Response `200`

Success

- OcapiV1BrowsingAvailabilityFilmsFilmAvailabilityDetails: Represents a film availability entity, and its related data
  - `filmAvailability` OcapiV1BrowsingAvailabilityFilmsFilmAvailability, required: Represents the current availability of a film
    - `filmId` string, required: Gets the unique identifier of the film
    - `siteId` string, nullable: Gets the unique identifier of the site
    - `categories` OcapiV1BrowsingAvailabilityFilmsFilmCategory[], required: Gets the list of film category entities
    - `showtimeAttributeIds` string[], required: Gets the list of unique identifiers of the attribute entities being screened
    - `advanceBookingPeriods` OcapiV1BrowsingMasterDataFilmAdvanceBookingsFilmAdvanceBookingPeriod[], required: Gets the list of film advance booking period entities
      - `startsAt` string, date-time, required: Gets the date and time that the booking period starts
      - `orderBookingModes` OcapiV1OrdersBookingsOrderBookingMode[], required: Gets the order booking modes that the booking period applies to
      - `restriction` 'None' | 'MemberReward', required: Represents the restriction options for a film advance booking period
      - `rewardId` integer, nullable: Gets the unique identifier of the reward that the booking period is restricted to
  - `relatedData` OcapiV1BrowsingAvailabilityFilmsFilmAvailabilityRelatedData, required: Related data for a film availability entity
    - `attributes` OcapiV1BrowsingMasterDataAttributesAttribute[], required: Gets the list of related attribute entities
      - `id` string, required: Gets the unique identifier
      - `name` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required: Gets the text in the default language
        - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages
          - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required: Gets the translated text
      - `shortName` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required: Gets the text in the default language
        - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages
          - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required: Gets the translated text
      - `description` OcapiV1Translatable: Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required: Gets the text in the default language
        - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages
          - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required: Gets the translated text
      - `importantMessage` OcapiV1Translatable: Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required: Gets the text in the default language
        - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages
          - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required: Gets the translated text
      - `displayPriority` integer, required: Gets the display priority used for sorting
      - `isPromoted` boolean, required: Gets a value indicating whether the attribute should be displayed with prominence

## Other responses

- `404`: Film does not exist.

---

[API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)