Cineamo API Reference
Welcome to the Cineamo API. The API is organized around REST: it has resource-oriented URLs, accepts JSON request bodies, returns HAL-formatted JSON responses, and uses standard HTTP verbs and status codes. All requests are served over HTTPS from https://api.cineamo.com and authenticated with OAuth 2.0; list endpoints share common pagination and filtering semantics. If this is your first integration, the Getting Started guide walks you through your first authenticated request — and we're happy to help at support@cineamo.com.
The reference is organized into the sections below. Use the filter at the top of the sidebar to jump straight to an endpoint.
Analytics
Aggregate counts, averages, and revenue metrics across the platform, plus Pulse Analytics for product analytics.
Booking & Checkout
The online ticketing flow from basket to issued ticket: Carts, Orders, Tickets with purchase intents and fee rules, Gift Cards, and the Pricing model of price options, factors, and discounts.
Cinemas
Everything that describes a venue and its operation: core cinema records, rooms with seating and equipment, opening hours, and per-cinema configuration. Also covers commercial data — payouts, bank accounts, products, promotions — and venue content such as blogs, FAQs, microsites, chains, and companies.
Distribution & Advertising
Endpoints for film distributors and advertisers: Distributors and their firms, movie statistics, Deals, and Advertising campaigns with impression and click tracking.
Events
Event Requests cover the whole lifecycle of a private or special screening request, from submission to confirmation.
Media & Contents
Binary and media handling: Assets, Images, file uploads, QR code generation, and the Crawling infrastructure that ingests external sources.
Messaging & Newsletters
Outbound communication: Newsletter configuration, campaigns, and subscribers, plus in-app Notifications and their subscriptions.
Movies
Film metadata and its facets: core Movie records, versions, trailers, ratings, and aliases, together with reference data such as genres, age ratings, and content types.
Showings & Programming
Scheduling and programme planning: concrete Showings (showtimes) with their tags, planned showing dates with audience voting, time slots, Movie Tours, and showtime imports.
Social & Community
Community features around the movie-going experience: Buddy Groups, discussion Threads, Comments, and direct Messages.
Users & Accounts
Account and identity management: Users and roles, federated Identities, the authenticated user's own /me endpoints, curated Movie Lists, and User Feedback.
Administration & System
Platform-level administration: Tenants, CORS origins, copyright conditions, queue utilities, and the unauthenticated public guest endpoints.