Featured Content

Server

Featured and upcoming content on cinema pages.

Get a cart gift card

GET

https://api.cineamo.com

/cinema-content-upcomings/{cartGiftCard}

Returns a CartGiftCard object by its Id.

Get a cart gift card › path Parameters

cartGiftCard

integer · required

Get a cart gift card › Responses

CartGiftCard details

CartGiftCard

id

integer · readOnly

cartUuid

string | null · readOnly

Cart

giftCardId

integer | null · readOnly

GiftCard

createdDatetime

string | null · readOnly

GET/cinema-content-upcomings/{cartGiftCard}

curl https://api.cineamo.com/cinema-content-upcomings/:cartGiftCard

Example Responses

{
  "id": 1,
  "cartUuid": "550e8400-e29b-41d4-a716-446655440000",
  "cart": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "user": {
      "id": 123,
      "username": "i_am_batman",
      "firstName": "Frank",
      "lastName": "Pentangeli",
      "profileImageRef": "00000000-0000-0000-0000-000000000000",
      "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
      "isActivated": true,
      "isDeleted": "true",
      "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
    },
    "client": "web",
    "createdDatetime": "2022-04-11T04:11:22Z",
    "priceNet": 100,
    "priceTotal": 100,
    "amountDue": 1080,
    "priceBreakdown": [
      {
        "type": "tax",
        "label": "VAT 19%",
        "amount": 380
      }
    ],
    "onlineTicketingFee": 10,
    "isPaid": "true",
    "paidDatetime": "2022-04-11T04:11:22Z",
    "cinemaId": 1,
    "orderId": 123
  },
  "giftCardId": 42,
  "giftCard": {
    "id": 42,
    "giftCardTypeId": 1,
    "code": "ABCD-1234-EFGH",
    "ticketSystemId": "TS-9876",
    "createdDatetime": "2022-04-11T04:11:22Z"
  },
  "createdDatetime": "2022-04-11T04:11:22Z"
}

json

application/json

List cinema content upcomings

GET

https://api.cineamo.com

/cinema-content-upcomings

Returns a list of CinemaContentUpcoming objects.

List cinema content upcomings › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

releaseDateStart

string · date

releaseDateEnd

string · date

isHidden

boolean

hasReleaseDate

boolean

scope

string[]

Enum values:

unscheduled

List cinema content upcomings › Responses

CinemaContentUpcoming list

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

GET/cinema-content-upcomings

curl https://api.cineamo.com/cinema-content-upcomings

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "releaseDate": "2022-04-11",
  "position": 1
}

json

application/json

Get a cinema content upcoming

GET

https://api.cineamo.com

/cinema-content-upcomings/{cinemaContentUpcoming}

Returns a CinemaContentUpcoming object by its Id.

Get a cinema content upcoming › path Parameters

cinemaContentUpcoming

integer · required

Get a cinema content upcoming › Responses

CinemaContentUpcoming details

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

GET/cinema-content-upcomings/{cinemaContentUpcoming}

curl https://api.cineamo.com/cinema-content-upcomings/:cinemaContentUpcoming

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "releaseDate": "2022-04-11",
  "position": 1
}

json

application/json

Get a cinema featured content

GET

https://api.cineamo.com

/cinema-featured-contents/{cinemaFeaturedContentId}

Returns a CinemaFeaturedContent object by its Id.

Get a cinema featured content › path Parameters

cinemaFeaturedContentId

integer · required

Get a cinema featured content › Responses

CinemaFeaturedContent details

CinemaFeaturedContent

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null

GET/cinema-featured-contents/{cinemaFeaturedContentId}

curl https://api.cineamo.com/cinema-featured-contents/:cinemaFeaturedContentId

Example Responses

{
  "id": 1,
  "createdDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "content": {
    "id": 1,
    "name": "some content name",
    "slug": "some-content-name",
    "category": "movie_series",
    "description": "description",
    "isOwnContent": true,
    "duration": 160,
    "creatorCinemaId": 1,
    "posterImageRef": "00000000-0000-0000-0000-000000000000",
    "posterImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-profile",
    "backdropImageRef": "00000000-0000-0000-0000-000000000000",
    "backdropImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/content-backdrop",
    "ageRating": "18",
    "trailerUrl": "https://example.com/trailer.mp4",
    "isRegularEvent": true,
    "hasMarketingAssistantBooked": true,
    "futureShowingsCount": 5,
    "premiereDate": "2022-04-11T04:11:22Z",
    "movie": {
      "id": 1,
      "tmdbId": 1,
      "cineamoId": "155m",
      "title": "Some Movie Title",
      "lastUpdated": 0,
      "isTmdbSyncSkipped": true,
      "series": true,
      "selectedByCinema": true,
      "adult": true,
      "backdropPath": "backdropPath",
      "genres": [
        {
          "id": 0,
          "name": "name"
        }
      ],
      "homepage": "homepage",
      "imdbId": "imdbId",
      "originalLanguage": "originalLanguage",
      "originalTitle": "Some Original Title",
      "overview": "Some movie overview...",
      "popularity": 0,
      "posterPath": "posterPath",
      "productionCompanies": [
        {
          "name": "name",
          "id": 0,
          "logoPath": "logoPath",
          "originCountry": "originCountry"
        }
      ],
      "productionCountries": [
        {}
      ],
      "releaseDate": "releaseDate",
      "revenue": 0,
      "runtime": 0,
      "firstAirDate": "firstAirDate",
      "status": "status",
      "tagline": "tagline",
      "video": true,
      "voteAverage": 0,
      "voteCount": 0,
      "alternativeTitles": {},
      "credits": {},
      "images": {},
      "videos": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "translations": {
        "id": 0,
        "translations": 0
      },
      "similar": {
        "page": 0,
        "totalPages": 0,
        "totalResults": 0,
        "results": [
          "string"
        ]
      },
      "releaseDates": {
        "id": 0,
        "results": [
          "string"
        ]
      },
      "noRightsAvailable": true,
      "noRightsTimestamp": 0,
      "thirdParties": {
        "moviePilot": {
          "voteAverage": 0,
          "link": "link",
          "voteCount": 0
        }
      },
      "slug": "some-slug",
      "rentrakTitle": 0,
      "movieAccessibility": {
        "id": 1,
        "movieId": 1,
        "iso31661": "DE",
        "gretaMovieId": "abc123",
        "hasClosedCaption": false,
        "hasAudioDescription": false,
        "hasSoundAmplification": false
      }
    },
    "movieId": 123,
    "metrics": {
      "messagesCount": 0,
      "clickedMessagesCount": 0,
      "ticketPurchaseIntentsCount": 0
    }
  },
  "highlightText": "Summer blockbuster",
  "desktopImageRef": "00000000-0000-0000-0000-000000000000",
  "mobileImageRef": "00000000-0000-0000-0000-000000000000",
  "activeFromDatetime": "2024-08-25T15:00:00Z",
  "activeUntilDatetime": "2024-08-25T15:00:00Z",
  "showFeatureBadge": false,
  "featureBadge": "Vorverkauf",
  "showButton": false,
  "buttonTitle": "Tickets sichern",
  "reason": "pre_sale",
  "highlightColor": "#467c9c",
  "link": "https://example.com/tickets",
  "position": 0
}

json

application/json

Equipments Room Objects

Get a cart gift card

GET

https://api.cineamo.com

/cinema-content-upcomings/{cartGiftCard}

Returns a CartGiftCard object by its Id.

Get a cart gift card › path Parameters

cartGiftCard

integer · required

Get a cart gift card › Responses

CartGiftCard details

CartGiftCard

id

integer · readOnly

cartUuid

string | null · readOnly

Cart

giftCardId

integer | null · readOnly

GiftCard

createdDatetime

string | null · readOnly

List cinema content upcomings

GET

https://api.cineamo.com

/cinema-content-upcomings

Returns a list of CinemaContentUpcoming objects.

List cinema content upcomings › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaIds

integer[]

releaseDateStart

string · date

releaseDateEnd

string · date

isHidden

boolean

hasReleaseDate

boolean

scope

string[]

Enum values:

unscheduled

List cinema content upcomings › Responses

CinemaContentUpcoming list

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

Get a cinema content upcoming

GET

https://api.cineamo.com

/cinema-content-upcomings/{cinemaContentUpcoming}

Returns a CinemaContentUpcoming object by its Id.

Get a cinema content upcoming › path Parameters

cinemaContentUpcoming

integer · required

Get a cinema content upcoming › Responses

CinemaContentUpcoming details

CinemaContentUpcoming

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

releaseDate

string | null · readOnly

position

integer | null

Get a cinema featured content

GET

https://api.cineamo.com

/cinema-featured-contents/{cinemaFeaturedContentId}

Returns a CinemaFeaturedContent object by its Id.

Get a cinema featured content › path Parameters

cinemaFeaturedContentId

integer · required

Get a cinema featured content › Responses

CinemaFeaturedContent details

CinemaFeaturedContent

id

integer · readOnly

createdDatetime

string | null · readOnly

readOnly

highlightText

string | null

desktopImageRef

string | null · uuid

mobileImageRef

string | null · uuid

activeFromDatetime

string | null · date-time

activeUntilDatetime

string | null · date-time

showFeatureBadge

boolean

featureBadge

string | null

showButton

boolean

buttonTitle

string | null

reason

string | null

highlightColor

string | null

link

string | null

position

integer | null