Get started
Overview
Filmo exposes the records of a rental company, such as contacts, items, orders, invoices and crew, through a REST API and an MCP server for AI assistants.
Both use the same API key, the same scopes and the same rate limits. Use them to connect a CRM, send web-form requests into Filmo, mirror inventory, sync the schedule or let an assistant look things up.
What the platform includes
Link to this section: What the platform includesHTTPS and JSON. Every operation has a page, with its scope, parameters and responses, and the full OpenAPI document is downloadable.
Every operation of the API is also a tool for AI assistants, with the same authentication and the same scopes.
List the workflows of the account and start the ones with a manual trigger.
An upcoming SDK for building external applications in your own environment with Filmo's components, backend and API.
The reference describes 170 operations behind 59 scopes. The API does not send webhooks: to follow changes you poll for what changed, as Syncing data explains.
Before you start
Link to this section: Before you start- An administrator of the Filmo account creates the API key, and the key acts as that administrator. If you are not one, the quickstart says what to ask for.
- Filmo must have switched the API and MCP on for the environment your account lives in. That is a switch on Filmo's side, not a setting an administrator of the account changes. The API and MCP are included in any paid plan and are not an add-on, but the modules with add-ons need them:
GET /apilists the add-ons the account has today, and a resource behind an add-on that is not listed answers 402/v1 /account addon_required. See Plans and add-ons. - A free trial (14 days, no card) is a good way to try the API: an administrator can create keys and connect OAuth and MCP, and the trial unlocks all add-ons. When it ends, endpoints behind an add-on answer 402, and unless the account has been converted to a paid subscription its data is purged about 30 days after the end. Check
trialbefore you build on a trial. - This documentation is public. Only the key is restricted, and a key is shown once, when it is created.
The rate limits are the same for every plan. To see which add-ons your account has, check your subscription in Filmo (Your subscription).
Choose where to start
Link to this section: Choose where to startCreate a key and read your account in a few minutes, in cURL, PowerShell, Node or Python.
Point an AI client at the MCP server and choose what it may do.
What each resource supports, the hard limits and what is not in v1.
The checklist before an integration touches production data.
Building for many rental companies, as a software vendor? Read Multi-account integrations. The concepts that every integration meets are accounts and tenancy, records and ids, statuses and permissions.
Stability
Link to this section: StabilityThe contract is versioned. Changes within v1 are additive; breaking changes follow the notice periods in Versioning. Ignore properties and values you do not know, so additive changes do not break you.
Business-sensitive data such as costs, margins and access codes is not published by design; see Excluded data. For help, see Support.
Related pages
Link to this section: Related pagesGet started
Quickstart
Create an API key in the API and MCP section of the Filmo settings, then call
GET /api. The response tells you the timezone, currency, add-ons and scopes to build with./v1 /account Introduction
REST API overview
The Filmo REST API v1 is a JSON API over HTTPS at
https://. You authenticate with an API key, and every response uses the same envelope.app. filmo. io /api /v1 Introduction
MCP server
Connect an AI assistant to your Filmo account. It can use exactly the tools its key or connection allows.
Further reading
Capabilities and limits of v1
The API covers most day-to-day work on orders, contacts, items, invoices and the schedule, and leaves a short list of things to the app. Check it here before you design an integration around a feature.
Was this page helpful?