REST API overview

Every path in this reference starts with /api/v1, on the origin https://app.filmo.io: for example, GET /api/v1/orders. Requests and successful responses are JSON (application/json); errors are application/problem+json.

A good first call is GET /api/v1/account. It needs the account:read scope and returns the account, the timezone in which bare days are read, and the scopes of the key you used. To create a key, an administrator opens the API and MCP section of the account settings in Filmo (*Ajustes → API y MCP*); see Authentication.

curl -sS --fail-with-body "${FILMO_BASE_URL:-https://app.filmo.io}/api/v1/account" \
  -H "Authorization: Bearer $FILMO_API_KEY"

const base = process.env.FILMO_BASE_URL ?? "https://app.filmo.io";
const res = await fetch(base + "/api/v1/account", {
  headers: { Authorization: `Bearer ${process.env.FILMO_API_KEY}` },
});
if (!res.ok) throw new Error(res.status + " " + (await res.text()));
const { data } = await res.json();
console.log(data.name, data.timezone, data.currency);

import os
import requests

base = os.environ.get("FILMO_BASE_URL", "https://app.filmo.io")
res = requests.get(
    base + "/api/v1/account",
    headers={"Authorization": f"Bearer {os.environ['FILMO_API_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()["data"]
print(data["name"], data["timezone"], data["currency"])

For a guided walk from a new key to your first write, follow the quickstart. The OpenAPI file and the clients you can generate from it are covered in OpenAPI file and generated clients; the reference of every operation is in the OpenAPI reference.

Every response from the API has one of three shapes.

API responses carry an X-Request-Id header, and error bodies repeat it as requestId. Quote it when you contact support. The OAuth endpoints are the exception: they do not return it. The headers, the extra meta object some operations return and the statuses in use are in Responses; every error code is in Errors.

• Ask an administrator of the rental company to create the key, and decide who owns it: Authentication.
• Give the key only the permissions the integration uses: Scopes.
• Read what v1 covers, and what it does not, in Capabilities and limits.
• Check which add-ons your account has: the API and MCP are included in any paid plan and are not an add-on, but a resource that belongs to a module with an add-on you have not contracted answers 402 addon_required. See Plans and add-ons.
• A key works on the live data of the account it belongs to. Read Testing before your first write.
• Before you go to production, work through Going live.

Check the contract version returned by GET /api/v1/account or published in the OpenAPI file. The compatibility rules and notice periods are documented in Versioning.

v1 does not send webhooks. To keep another system in step with Filmo, poll incrementally: ask each list that has updated* filters for the records that changed since your last pass. Syncing data describes an algorithm that does not skip records and how to detect deletions.

Every operation is also an MCP tool at https://app.filmo.io/api/v1/mcp, with the same key and scopes. See the MCP overview.