# 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](/getting-started/hal-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](/getting-started/authentication); list endpoints share common [pagination](/guides/pagination) and [filtering](/guides/filtering) semantics. If this is your first integration, the [Getting Started guide](/getting-started/introduction) walks you through your first authenticated request — and we're happy to help at [support@cineamo.com](mailto: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](/api/analytics)

Aggregate counts, averages, and revenue metrics across the platform, plus [Pulse Analytics](/api/pulse-analytics) for product analytics.

## Booking & Checkout

The online ticketing flow from basket to issued ticket: [Carts](/api/carts), [Orders](/api/orders), [Tickets](/api/tickets) with purchase intents and fee rules, [Gift Cards](/api/gift-cards), and the [Pricing](/api/pricing) model of price options, factors, and discounts.

## Cinemas

Everything that describes a venue and its operation: core [cinema records](/api/cinemas), [rooms](/api/cinema-rooms) with [seating](/api/seats) and [equipment](/api/equipments), [opening hours](/api/cinema-opening-hours), and [per-cinema configuration](/api/cinema-configurations). Also covers commercial data — [payouts](/api/cinema-payouts), [bank accounts](/api/bank-accounts), [products](/api/cinema-products), [promotions](/api/cinema-promotions) — and venue content such as [blogs](/api/cinema-blogs), [FAQs](/api/cinema-faqs), [microsites](/api/cinema-sites), [chains](/api/cinema-chains), and [companies](/api/cinema-companies).

## Distribution & Advertising

Endpoints for film distributors and advertisers: [Distributors](/api/distributors) and their [firms](/api/firms), [movie statistics](/api/distributor-statistics), [Deals](/api/deals), and [Advertising](/api/advertising) campaigns with impression and click tracking.

## Events

[Event Requests](/api/event-requests) cover the whole lifecycle of a private or special screening request, from submission to confirmation.

## Media & Contents

Binary and media handling: [Assets](/api/assets), [Images](/api/images), [file uploads](/api/upload), [QR code generation](/api/qr-codes), and the [Crawling](/api/crawling) infrastructure that ingests external sources.

## Messaging & Newsletters

Outbound communication: [Newsletter](/api/newsletter) configuration, campaigns, and subscribers, plus in-app [Notifications](/api/notifications) and their subscriptions.

## Movies

Film metadata and its facets: core [Movie](/api/movies) records, [versions](/api/movie-versions), [trailers](/api/movie-trailers), [ratings](/api/movie-ratings), and [aliases](/api/movie-aliases), together with reference data such as [genres](/api/genres), [age ratings](/api/age-ratings), and [content types](/api/contents).

## Showings & Programming

Scheduling and programme planning: concrete [Showings](/api/showings) (showtimes) with their [tags](/api/showing-tags), planned [showing dates](/api/showing-dates) with audience voting, [time slots](/api/time-slots), [Movie Tours](/api/movie-tours), and [showtime imports](/api/cinema-showtimes-imports).

## Social & Community

Community features around the movie-going experience: [Buddy Groups](/api/buddy-groups), discussion [Threads](/api/threads), [Comments](/api/comments), and direct [Messages](/api/messages).

## Users & Accounts

Account and identity management: [Users](/api/users) and roles, federated [Identities](/api/identities), the authenticated user's own [/me endpoints](/api/current-user-me), curated [Movie Lists](/api/movie-lists), and [User Feedback](/api/user-feedback).

## Administration & System

Platform-level administration: [Tenants](/api/tenants), [CORS origins](/api/cors-origins), [copyright conditions](/api/copyright-conditions), [queue utilities](/api/queues), and the unauthenticated [public guest endpoints](/api/public-guest-endpoints).