ftrack

Extend and customize ftrack with the powerful API – built for pipeline developers for deeper functionality and greater flexibility.

Getting started with the API

Fredrik Limsater

Mattias Seebergs

Linda Uldrich

Discover how to develop with ftrack for tighter integration and more customisation options.

Developing with ftrack Studio

Official and community supported clients for the API such as python and javascript.

API Clients

In this article, you will learn how to authenticate using personal and global API keys.

API keys

Learn how to use the different API clients by example.

Examples

Publish versions that can be reviewed using the review tools available in ftrack.

Review

Learn how to get started building custom widgets for use on dashboards and Actions in ftrack.

Creating a custom widget (with React)

General

Detect changes in ftrack using the event hub and learn about the available events.

Events

Extend ftrack with actions and interact with users via simple forms or flexible widgets.

Actions

Learn how to create your own widgets and use them on dashboards or as actions.

Custom widgets

Learn how to access locations using the API and write your own location plugins.

Locations

How to publish files to ftrack and some of the core concepts around it.

Publishing

Björn Rydahl

Key Concepts

Overview of the API endpoint and how it can be used to create an API client for another programming language.

Overview

Learn about the different operations supported by the server and how to format the request data.

Operations

Schemas describe which entity types and attributes are available for a particular server.

Schemas

API query language is used to filter, sort and specify what data to query.

Query Syntax

Advanced query examples for API clients and advanced filter queries.

Query examples

Speed and Performance Tips for API Queries

How to upload and download components from the ftrack.server location.

Data transfer

API Endpoint

ftrack status

ftrack community

ftrack developer

Find answers and get help from Intercom Support and Community Experts

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Title

{assigneeName} needs more information from you