Core cinema venue records.
List cinemas
Returns a list of Cinema objects.
query Parameters
pageperPagesortorderqueryisPrivateBookingPartnerisActivecitycountryCodeemployedUserIdfavoritedUserIdlongitudelatitudedistance(in meters)
cinemaChainIdisFavoritehasMarketingAssistantBookedisWebsiteCustomerembedmetricStartDatetimemetricEndDatetimekinofestPartnerCinemaDatetimeStartcinemaCompanyIds[]cinemaChainIds[]cityIds[]Cinemas whose City relation matches any of the given City ids. Distinct from city, which matches the denormalised city name string.
subscriptionPrograms[]Cinemas participating in ANY of the given subscription programs
hasSubscriptionProgramCinemas participating in at least one subscription program
movieIdCinemas that have at least one showing of the given movie
showingDatetimeStartRestricts the showings considered by movieId to those starting at or after this point
showingDatetimeEndRestricts the showings considered by movieId to those starting before this point
List cinemas › Responses
A list of Cinema objects
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedCreate a cinema
Creates a cinema. Returns the created cinema.
Create a cinema › Request Body
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedCreate a cinema › Responses
Cinema was created
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedSet cinema cinema distinction
Creates or updates a CinemaDistinction relationship between a cinema and distinction.
path Parameters
cinemaIddistinctionIdSet cinema cinema distinction › Request Body
idcreatedDatetimepositionSet cinema cinema distinction › Responses
Cinema distinction has been updated
idcreatedDatetimepositionList cinema cinema distinctions
Returns a list of CinemaDistinction objects for a cinema.
path Parameters
cinemaIdquery Parameters
pageperPagesortorderList cinema cinema distinctions › Responses
CinemaDistinction list
idcreatedDatetimepositionCreate a cinema featured content
Creates a featured content entry for a cinema.
path Parameters
cinemaIdCreate a cinema featured content › Request Body
idcreatedDatetimehighlightTextdesktopImageRefmobileImageRefactiveFromDatetimeactiveUntilDatetimeshowFeatureBadgefeatureBadgeshowButtonbuttonTitlereasonhighlightColorlinkpositionCreate a cinema featured content › Responses
Cinema featured content has been created
idcreatedDatetimehighlightTextdesktopImageRefmobileImageRefactiveFromDatetimeactiveUntilDatetimeshowFeatureBadgefeatureBadgeshowButtonbuttonTitlereasonhighlightColorlinkpositionUpdate a cinema featured content
Partially updates a featured content entry. Only the provided fields are changed.
path Parameters
cinemaIdcinemaFeaturedContentIdUpdate a cinema featured content › Request Body
idcreatedDatetimehighlightTextdesktopImageRefmobileImageRefactiveFromDatetimeactiveUntilDatetimeshowFeatureBadgefeatureBadgeshowButtonbuttonTitlereasonhighlightColorlinkpositionUpdate a cinema featured content › Responses
Cinema featured content has been updated
idcreatedDatetimehighlightTextdesktopImageRefmobileImageRefactiveFromDatetimeactiveUntilDatetimeshowFeatureBadgefeatureBadgeshowButtonbuttonTitlereasonhighlightColorlinkpositionList cinema featured contents
Returns a list of CinemaFeaturedContent objects.
query Parameters
pageperPagesortorderactiveDatetimeList cinema featured contents › Responses
CinemaFeaturedContent list
idcreatedDatetimehighlightTextdesktopImageRefmobileImageRefactiveFromDatetimeactiveUntilDatetimeshowFeatureBadgefeatureBadgeshowButtonbuttonTitlereasonhighlightColorlinkpositionSet cinema images
Sets a list of Image objects (Cinema images).
Set cinema images › Request Body
idpathimageRefimageUrlpositionimageDescriptionSet cinema images › Responses
A list of Cinema Image objects were set
idpathimageRefimageUrlpositionimageDescriptionList orders for a cinema
Returns a list of Order objects.
query Parameters
pageperPagesortorderuserIdscreatedDatetimeStartcreatedDatetimeEndstatesList orders for a cinema › Responses
Order list
idcinemaIduserIdemailpriceNetpriceTotalstatecreatedDatetimeinvoiceIdinvoiceRefcartUuidFull price breakdown with all adjustments
clientList cinema cinema promotions
Returns a list of CinemaPromotion objects for a cinema.
path Parameters
cinemaIdquery Parameters
pageperPagesortorderactiveDatetimeList cinema cinema promotions › Responses
CinemaPromotion list
iddesktopImageRefdesktopImageUrlmobileImageRefmobileImageUrlimageDescriptionlinkvideoLinkactiveFromDatetimeactiveUntilDatetimepositioncinemaIdGet a cinema
Returns the requested cinema.
path Parameters
domainGet a cinema › Responses
Cinema details
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedGet a cinema
Returns the requested cinema.
path Parameters
cinemaSlugGet a cinema › Responses
Cinema details
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedGet a cinema
Returns the requested cinema.
path Parameters
cinemaIdGet a cinema › Responses
Cinema details
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedUpdate a cinema
Updates a cinema. Returns the updated cinema.
path Parameters
cinemaIdUpdate a cinema › Request Body
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedUpdate a cinema › Responses
Cinema was updated
idnamedescriptionstreetpostalCodecitystatestateAbbrcountrycountryCodecurrencyCodelongitudelatitudeemailisActiveshortNameslugphonedistance(in meters)
profileImageRefprofileImageUrllogoImageReflogoImageUrllogoWideImageReflogoWideImageUrlbrandImageUrlThe cinema's brand mark for a square or round slot: the logo, else the profile image. The wide logo is deliberately never used here, because every consumer of this field crops it square (a push notification icon, an avatar), which reduces a wide mark to its middle.
priceTablePdfRefpriceTablePdfUrlprimaryColorinstagramLinkfacebookLinkticketSystemIdticketSystemcinemaConfigurationIdshowtimesUpdatedisFavoritecineamoTrailerConfirmedDatetimekinofestPartnerCinemaDatetimemetricCustomersCountmetricCompareCustomersCountmetricCustomersTotalCountcinemaChainIdcinemaCompanyIdcityIdopeningHoursCustomTextsubscriptionProgramslinkedinLinkxLinkwhatsappLinktiktokLinkmetricRoomCountNumber of screening rooms that are not soft-deleted. Only set when embedded.
metricSeatCountSum of the seat counts of all rooms that are not soft-deleted. Rooms without a recorded seat count contribute nothing — read this together with metricSeatCountKnownRoomCount. Only set when embedded.
metricSeatCountKnownRoomCountHow many of the counted rooms actually carry a seat count, so consumers can tell a complete sum from a partial one. Only set when metricSeatCount is embedded.
timezoneIANA time zone of the cinema (e.g. "Europe/Berlin"). Null when the cinema has none recorded — consumers that need a fallback should apply their own.
homepageThe cinema's own website. Null when none is recorded.
hasMarketingAssistantBookedList cinema cinema rooms
Returns a list of CinemaRoom objects for a cinema.
path Parameters
cinemaIdquery Parameters
pageperPagesortorderqueryavailableDatetimeStartavailableDatetimeEndembedhasScreenscreenSizeStartscreenSizeEndList cinema cinema rooms › Responses
CinemaRoom list
idnamepositioncinemaIdcinemaSiteIdcinemaRoomShapeIdseatCountnotebasePriceisPrivateBookingEnabledisTheaterisHdmiPortisVgaPortisLanPortisWlanPortisDisplayportPortisPowerConnectionisDolbyAtmosReadyisThxReadyis5Point1Soundis7Point1SoundhasDboxSeatshasLeatherSeatshasPartnerSeatshasVipRowshasIncreasedRowSpacinghasWheelchairSpacesprofileImageUrlscreenIdffaIdisSyncDisabledprofileImageRefList cinema cinema sites
Returns all CinemaSites that belong to the given cinema.
path Parameters
cinemaIdquery Parameters
pageperPageList cinema cinema sites › Responses
CinemaSite list
idnamedescriptionstreetpostalCodecitystatestateAbbrphonelatitudelongitudeprofileImageRefcinemaIdcreatedDatetimeList cinema cinema site configurations
Returns a list of CinemaSiteConfiguration objects for a cinema.
path Parameters
cinemaIdquery Parameters
pageperPagesortorderList cinema cinema site configurations › Responses
CinemaSiteConfiguration list
idcinemaSiteIdticketSystemticketSystemIdticketUrlTemplateticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixshowtimesAdapterConfigurationcreatedDatetimeupdatedDatetimeList cinema contents
Returns a list of Content objects for a specific cinema.
path Parameters
cinemaIdquery Parameters
pageperPagesortorderquerycreatorCinemaIdcineamoMovieIdDeprecated: use movieId instead (filters by the legacy Cineamo movie id).
movieIdFilter contents by the movie id (Content.movie relation). Takes precedence over cineamoMovieId when both are given.
showingDateshowingStartDateTimeshowingEndDateTimehasPreviewShowingstrue keeps only contents with showings on or before their release date (preview screenings and release-day showings), false only those whose showings all start after it.
hasPremiereShowingsDeprecated: use hasPreviewShowings instead (CIN-14521 renamed it). Still honoured for already-released clients; when both are sent, hasPreviewShowings wins.
metricStartDatetimemetricEndDatetimehasMarketingAssistantBookedcinemaCountryCodeisMovieisShowingNowList cinema contents › Responses
Cinema contents list
idnameslugcategorydescriptiondescriptionEnisOwnContentdurationcreatorCinemaIdposterImageRefposterImageUrlbackdropImageRefbackdropImageUrlageRatingtrailerUrlhasMarketingAssistantBookedfutureShowingsCountpremiereDatemovieIdisRegularEventGet a cinema content
Returns a Content object for a specific cinema.
path Parameters
cinemaIdcontentIdGet a cinema content › Responses
Cinema content details
idnameslugcategorydescriptiondescriptionEnisOwnContentdurationcreatorCinemaIdposterImageRefposterImageUrlbackdropImageRefbackdropImageUrlageRatingtrailerUrlhasMarketingAssistantBookedfutureShowingsCountpremiereDatemovieIdisRegularEventSet cinema cinema content upcoming
Creates or updates a CinemaContentUpcoming relationship between a cinema and content.
path Parameters
cinemaIdcontentIdSet cinema cinema content upcoming › Request Body
idcreatedDatetimereleaseDatepositionSet cinema cinema content upcoming › Responses
Cinema content upcoming has been updated
idcreatedDatetimereleaseDatepositionList cinema cinema content upcomings
Returns a list of CinemaContentUpcoming objects.
query Parameters
pageperPagesortorderquerycinemaIdsreleaseDateStartreleaseDateEndisHiddenhasReleaseDatescopeList cinema cinema content upcomings › Responses
CinemaCinemaContentUpcoming list
idcreatedDatetimereleaseDatepositionList cinema movies
Returns a list of Movie objects for a specific cinema.
path Parameters
cinemaIdquery Parameters
pageperPagesortorderquerycineamoMovieIdDeprecated: use movieId instead (filters by the legacy Cineamo movie id).
movieIdFilter movies by the numeric movie id (Movie.id).
releaseDateStartreleaseDateEndregiondistributorIdisShowingNowcinemaCountryCodetypeList cinema movies › Responses
Movie list for cinema
idoriginalTitlecinemaIdtmdbIdtitlelastUpdatedisTmdbSyncSkippedseriesselectedByCinemaadultbackdropPathhomepageimdbIdoriginalLanguageoverviewpopularityposterPathproductionCountriesreleaseDaterevenueruntimefirstAirDatestatustaglinevideovoteAveragevoteCountnoRightsAvailablenoRightsTimestampslugrentrakTitlecineamoIdGet a cinema movie
Returns a Movie object for a specific cinema with cinema-specific customizations.
path Parameters
cinemaIdmovieIdGet a cinema movie › Responses
Cinema-specific movie details
idoriginalTitlecinemaIdtmdbIdtitlelastUpdatedisTmdbSyncSkippedseriesselectedByCinemaadultbackdropPathhomepageimdbIdoriginalLanguageoverviewpopularityposterPathproductionCountriesreleaseDaterevenueruntimefirstAirDatestatustaglinevideovoteAveragevoteCountnoRightsAvailablenoRightsTimestampslugrentrakTitlecineamoIdSet cinema movie customization
Creates or updates a MovieCustomization relationship between a cinema and movie.
path Parameters
cinemaIdmovieIdSet cinema movie customization › Request Body
idcreatedDatetimetitledescriptionposterImageRefposterImageUrlbackdropImageRefbackdropImageUrliso6393ISO 639-3 language code
preferedTrailerUrlCustom trailer URL
isActiveSet cinema movie customization › Responses
Movie customization has been updated
idcreatedDatetimetitledescriptionposterImageRefposterImageUrlbackdropImageRefbackdropImageUrliso6393ISO 639-3 language code
preferedTrailerUrlCustom trailer URL
isActiveList cinema movie customizations
Returns a list of MovieCustomization objects for a specific cinema.
query Parameters
pageperPagesortorderquerymovieIdsList cinema movie customizations › Responses
MovieCustomization list
idcreatedDatetimetitledescriptionposterImageRefposterImageUrlbackdropImageRefbackdropImageUrliso6393ISO 639-3 language code
preferedTrailerUrlCustom trailer URL
isActiveList cinema future showings
Returns a list of Showing objects for specific Cinema.
query Parameters
sortorderquerycinemaRoomIdscineamoMovieIdDeprecated: use movieId instead (filters by the legacy Cineamo movie id).
movieIdFilter showings by the movie id (Content.movie relation). Takes precedence over cineamoMovieId when both are given.
namecontentIdisEventRequestisThreeDimensionalisOriginalLanguageshowingTagIdshasShowingTagslanguagesubtitledLanguagecountryCodeisHighlightAfterDatetimeembedList cinema future showings › Responses
Showings list
contentIdeventRequestIdnameisThreeDimensionalisRegularShowtimeidcinemaRoomIdstartDatetimeendDatetimestateisDolbyAtmoslanguageoriginalLanguageisOriginalLanguageisDubbeddubbedLanguageisSubtitledsubtitledLanguagecineamoMovieIdmovieIdonlineTicketUrlcinemaIdimageUrlhighlightAfterDatetimehighlightTextstartSaleDatetimeendSaleDatetimeisImaxisDolbyVisionisDolbyCinemais4DXisScreenXisLiveisHFRisDboxticketUrlsbookingUrlExternalshowingTagIdsIDs of tags attached to this showing
isPreviewTrue when the showing starts on the movie's cinema release date in the cinema's country — a preview screening or release-day showing. Null when the start date, the cinema country or the movie release dates are unknown.
protectedColumnsProperty names that will not be overridden during showtime import
isPremiereDeprecated: use isPreview instead (CIN-14521 renamed the concept). Same value, kept so already-released clients — including the mobile apps — keep working.
Get a cinema advertisement clicks count
Returns the requested cinema advertisement clicks count.
path Parameters
cinemaIdadvertisementIdquery Parameters
placementsclientsdeviceTypesGet a cinema advertisement clicks count › Responses
CinemaAdvertisementClicksCount number
Get a cinema advertisement impressions count
Returns the requested cinema advertisement impressions count.
path Parameters
cinemaIdadvertisementIdquery Parameters
placementsclientsdeviceTypesGet a cinema advertisement impressions count › Responses
CinemaAdvertisementImpressionsCount number
List cinema cinema advertisements
Returns a list of CinemaAdvertisement objects. Only campaigns that target cinema websites (displayLocations contains cinema_website) are listed -- a cinema website can never serve any other campaign, so its relations are not shown to the cinema.
query Parameters
pageperPagesortorderquerydistributorIdsembedstatusesList cinema cinema advertisements › Responses
CinemaCinemaAdvertisement list
cinemaIdadvertisementIdisDeclinedmatchesCinemaShowingsGet a cinema advertisement by compound ID
Returns an CinemaAdvertisement object by its compound Id.
path Parameters
cinemaIdadvertisementIdGet a cinema advertisement by compound ID › Responses
CinemaAdvertisement details
cinemaIdadvertisementIdisDeclinedmatchesCinemaShowingsUpdate a cinema advertisement
Updates an CinemaAdvertisement.
path Parameters
cinemaIdadvertisementIdUpdate a cinema advertisement › Request Body
cinemaIdadvertisementIdisDeclinedmatchesCinemaShowingsUpdate a cinema advertisement › Responses
CinemaAdvertisement was updated
cinemaIdadvertisementIdisDeclinedmatchesCinemaShowingsCreate a replace cinema configuration
Create or fully replace a cinema configuration (PUT semantics — full replacement)
path Parameters
cinemaIdCreate a replace cinema configuration › Request Body
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringticketSystemticketSystemIdticketUrlTemplatefacebookAccessTokenhasMarketingAssistantBookedvisitorThreshold1visitorThreshold2isProgramSuggestionEnabledisPrivateBookingEnabledisActiveisOnlineTicketingEnabledonlineTicketingisKOSCustomerisInterestSystemActivatedisGiftCardRedemptionEnabledisWebsiteCustomerwebsiteConfigurationticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixdomainpulseTenantIdsubscriptionProgramsisPublicRequestAvailableisPrivateBookingPartnerisOnlineTicketingAvailableCreate a replace cinema configuration › Responses
CinemaConfiguration was replaced
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringticketSystemticketSystemIdticketUrlTemplatefacebookAccessTokenhasMarketingAssistantBookedvisitorThreshold1visitorThreshold2isProgramSuggestionEnabledisPrivateBookingEnabledisActiveisOnlineTicketingEnabledonlineTicketingisKOSCustomerisInterestSystemActivatedisGiftCardRedemptionEnabledisWebsiteCustomerwebsiteConfigurationticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixdomainpulseTenantIdsubscriptionProgramsisPublicRequestAvailableisPrivateBookingPartnerisOnlineTicketingAvailableConfiguration a cinema
Partial update of a cinema configuration by cinemaId
path Parameters
cinemaIdConfiguration a cinema › Request Body
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringticketSystemticketSystemIdticketUrlTemplatefacebookAccessTokenhasMarketingAssistantBookedvisitorThreshold1visitorThreshold2isProgramSuggestionEnabledisPrivateBookingEnabledisActiveisOnlineTicketingEnabledonlineTicketingisKOSCustomerisInterestSystemActivatedisGiftCardRedemptionEnabledisWebsiteCustomerwebsiteConfigurationticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixdomainpulseTenantIdsubscriptionProgramsisPublicRequestAvailableisPrivateBookingPartnerisOnlineTicketingAvailableConfiguration a cinema › Responses
CinemaConfiguration was updated
idminimalInitialEventVisitorrequestTimeoutAnswerisCateringticketSystemticketSystemIdticketUrlTemplatefacebookAccessTokenhasMarketingAssistantBookedvisitorThreshold1visitorThreshold2isProgramSuggestionEnabledisPrivateBookingEnabledisActiveisOnlineTicketingEnabledonlineTicketingisKOSCustomerisInterestSystemActivatedisGiftCardRedemptionEnabledisWebsiteCustomerwebsiteConfigurationticketUrlTemplateIosAppendixticketUrlTemplateAndroidAppendixticketUrlTemplateWebAppendixticketUrlTemplateCinemaWebsiteAppendixdomainpulseTenantIdsubscriptionProgramsisPublicRequestAvailableisPrivateBookingPartnerisOnlineTicketingAvailable
