Skip to content

⚒️ API Reference (1.0.0)

The Saturation API lets you work with your workspace data including projects, budgets, actuals, contacts, purchase orders, and attachments.

It is built for real-time collaboration and automation so you can connect it to your internal tools or third-party systems. Any changes you make through the API appear instantly in the web app.

With it, you can:

  • Create, update, and organize projects and phases
  • Build and track multi-phase budgets
  • Sync actuals and purchase orders
  • Manage contacts and crew
  • Upload, retrieve, and organize attachments

🔑 Authentication

GET /api/v1/projects
X-API-Key: YOUR_API_KEY


đź“Š Get everything in one call

GET /projects/my-film/budget?expands[]=phases&expands[]=fringes&expands[]=lines.contact&expands[]=lines.phaseData

Returns the complete budget with all related records, no extra roundtrips.

🏷️ Use your existing codes

GET /projects/my-film/budget/line/1100-LABOR    # Your account code
GET /projects/my-film/budget/phases/estimate    # Your phase name
POST /projects/my-film/actuals                  # Create with your codes
{
  "lineItemId": "2150-CAMERA",
  "amount": 5000
}

The API speaks your language. Use the same codes from your accounting system.

🔄 Common patterns

# Get recent actuals with full details
GET /projects/my-film/actuals?date=2024-03-14&expands[]=contact&expands[]=attachments

# Create a purchase order
POST /projects/my-film/purchase-orders
{
  "number": "PO-001",
  "contactId": "contact-123",
  "items": [{"lineItemId": "2150", "amount": 35000}]
}

# Export complete budget for accounting
GET /projects/my-film/budget?expands[]=phases&expands[]=fringes&expands[]=globals


đź’ˇ Pro tips

  • Create multiple budget lines in one POST to /budget
  • Use tags liberally—they're your flexible second dimension
  • Combine accountId, tags, and date filters for precise queries
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://support.saturation.io

License

Proprietary

Languages
Servers
Production server

https://api.saturation.io/api/v1/

Projects

Create and manage productions, campaigns, or jobs.
Each project has its own budget, actuals, and purchase orders.
Use idMode=user to reference projects by alias (e.g., "nike-spring-2024") instead of system IDs.

Operations

Contacts

Keep crew, contractors, and clients in one workspace-wide directory.
Link contacts to budget lines for automatic contact assignment.
Store tax info and rate cards for quick reuse across projects.

Operations

Rates

Define workspace-wide rate cards for consistent budgeting.
Set crew rates, equipment packages, and standard costs in multiple currencies.
Supports automatic fringe calculations.

Operations

Transactions

Import raw bank and card data, match to contacts, and convert to actuals.
Maintains a full audit trail from bank statement to budget line.

Operations

Budget

Build hierarchical budgets with accounts, line items, subtotals, and markups.
Use expands[]=phases&expands[]=fringes&expands[]=globals&expands[]=lines.contact&expands[]=lines.phaseData
to fetch complete budget data in one call.
Reference budget lines by account code (e.g., "1100-LABOR") with idMode=user.

Operations

Budget - Accounts

List all the budget accounts with children (i.e. Expanded Accounts)

Operations

Budget - Phases

Manage multiple budget versions (estimate, working, actual, committed).
Create rollup phases to auto-calculate variances.
Each phase supports its own currency.
Reference by name (e.g., "estimate") with idMode=user.

Operations

Budget - Fringes

Define payroll taxes and benefits (FICA, insurance, workers comp, etc.) once,
then auto-apply to all labor line items. Supports % or flat rates with salary cutoffs.

Operations

Budget - Globals

Set project-wide variables (e.g., exchange rates, shoot days, overhead %)
for use in formulas. Updating globals auto-recalculates dependent lines.

Operations

Actuals

Log real expenses from credit cards, manual entry, or converted POs.
Use expands[]=contact&expands[]=attachments to include contact details and receipts.
Split costs across multiple budget categories.

Operations

Purchase Orders

Create commitments to contacts/vendors before they become actuals.
Track approvals, link to budget lines, and monitor committed vs actual spend.
Convert POs to actuals when invoiced.

Operations

Tags

Categorize beyond account structure—e.g., by shoot day, location, department.
Use tags to run cross-budget reports and track spend across multiple categories.

Operations

List tags

Request

Retrieve all tags for a project with optional filtering and sorting.

Tags are used for categorizing budget line items and enable advanced filtering capabilities across budget data. Each tag includes financial totals aggregated from all associated budget line items.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
Query
namestring

Filter tags by name (partial match search)

Example: name=Post-Production
sortBystring

Field to sort by

Default "name"
Value"name"
Example: sortBy=name
sortOrderstring

Sort direction

Default "asc"
Enum"asc""desc"
Example: sortOrder=asc
idModestring

ID interpretation mode. Controls how path and query parameter IDs (like lineId, accountId, phaseId) are interpreted - 'user' for human-readable IDs (account codes, phase names), 'system' for database IDs (UUIDs/nanoids). Also affects the format of IDs in responses.

Default "user"
Enum"user""system"
Example: idMode=user
curl -i -X GET \
  'https://api.saturation.io/api/v1/projects/nike-spring-2024/tags?name=Post-Production&sortBy=name&sortOrder=asc&idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of project tags with financial totals

Bodyapplication/json
tagsArray of objects(TagResponse)required

Array of tags with their financial totals

tags[].​idstringrequired

Unique tag identifier (same as tag name)

Example: "Post-Production"
tags[].​namestring[ 1 .. 100 ] charactersrequired

Tag name (1-100 characters, immutable after creation)

Example: "Post-Production"
tags[].​colorstring^#[0-9A-Fa-f]{6}$

Optional hex color code for visual identification

Example: "#3B82F6"
tags[].​descriptionstring<= 500 characters

Optional description for documentation purposes

Example: "Post-production and VFX expenses"
tags[].​totalsobject(TagTotals)required

Financial totals aggregated from all budget line items assigned to this tag

tags[].​totals.​phaseTotalsobjectrequired

Total amounts by phase ID. Keys depend on idMode parameter:

  • idMode=user: phase aliases (e.g., "estimate", "actual")
  • idMode=system: internal database IDs (UUID strings)
Example: {"estimate":15000,"actual":12500}
tags[].​totals.​phaseTotals.​property name*number(float)additional property
tags[].​totals.​fringeTotalsobjectrequired

Fringe benefit totals by phase ID. Keys follow same format as phaseTotals.

Example: {"estimate":2250,"actual":1875}
tags[].​totals.​fringeTotals.​property name*number(float)additional property
tags[].​totals.​actualTotalnumber(float)required

Total actual expenses for this tag across all phases

Example: 14375
Response
application/json
{
  "tags": [
    { … }
  ]
}

Create tag

Request

Create a new tag for the project. Tags are used to categorize budget line items and enable advanced filtering capabilities.

Note: Tag names cannot be changed after creation. Only the color can be updated.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
Bodyapplication/jsonrequired
namestring[ 1 .. 100 ] charactersrequired

Tag name (must be unique within project)

Example: "Post-Production"
colorstring^#[0-9A-Fa-f]{6}$

Optional hex color code for visual identification

Example: "#3B82F6"
descriptionstring<= 500 characters

Optional description for documentation purposes

Example: "Post-production and VFX expenses"
curl -i -X POST \
  https://api.saturation.io/api/v1/projects/nike-spring-2024/tags \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Post-Production",
    "color": "#3B82F6",
    "description": "Post-production and VFX expenses"
  }'

Responses

Tag created successfully

Bodyapplication/json
idstringrequired

Unique tag identifier (same as tag name)

Example: "Post-Production"
namestring[ 1 .. 100 ] charactersrequired

Tag name (1-100 characters, immutable after creation)

Example: "Post-Production"
colorstring^#[0-9A-Fa-f]{6}$

Optional hex color code for visual identification

Example: "#3B82F6"
descriptionstring<= 500 characters

Optional description for documentation purposes

Example: "Post-production and VFX expenses"
totalsobject(TagTotals)required

Financial totals aggregated from all budget line items assigned to this tag

totals.​phaseTotalsobjectrequired

Total amounts by phase ID. Keys depend on idMode parameter:

  • idMode=user: phase aliases (e.g., "estimate", "actual")
  • idMode=system: internal database IDs (UUID strings)
Example: {"estimate":15000,"actual":12500}
totals.​phaseTotals.​property name*number(float)additional property
totals.​fringeTotalsobjectrequired

Fringe benefit totals by phase ID. Keys follow same format as phaseTotals.

Example: {"estimate":2250,"actual":1875}
totals.​fringeTotals.​property name*number(float)additional property
totals.​actualTotalnumber(float)required

Total actual expenses for this tag across all phases

Example: 14375
Response
application/json
{
  "id": "Post-Production",
  "name": "Post-Production",
  "color": "#3B82F6",
  "description": "Post-production and VFX expenses",
  "totals": {
    "phaseTotals": { … },
    "fringeTotals": { … },
    "actualTotal": 14375
  }
}

Get tag

Request

Retrieve a specific tag by ID, including its financial totals aggregated from all associated budget line items.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
tagIdstringrequired

Tag identifier (same as tag name)

Example: Post-Production
Query
idModestring

ID interpretation mode. Controls how path and query parameter IDs (like lineId, accountId, phaseId) are interpreted - 'user' for human-readable IDs (account codes, phase names), 'system' for database IDs (UUIDs/nanoids). Also affects the format of IDs in responses.

Default "user"
Enum"user""system"
Example: idMode=user
curl -i -X GET \
  'https://api.saturation.io/api/v1/projects/nike-spring-2024/tags/Post-Production?idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Tag details with financial totals

Bodyapplication/json
idstringrequired

Unique tag identifier (same as tag name)

Example: "Post-Production"
namestring[ 1 .. 100 ] charactersrequired

Tag name (1-100 characters, immutable after creation)

Example: "Post-Production"
colorstring^#[0-9A-Fa-f]{6}$

Optional hex color code for visual identification

Example: "#3B82F6"
descriptionstring<= 500 characters

Optional description for documentation purposes

Example: "Post-production and VFX expenses"
totalsobject(TagTotals)required

Financial totals aggregated from all budget line items assigned to this tag

totals.​phaseTotalsobjectrequired

Total amounts by phase ID. Keys depend on idMode parameter:

  • idMode=user: phase aliases (e.g., "estimate", "actual")
  • idMode=system: internal database IDs (UUID strings)
Example: {"estimate":15000,"actual":12500}
totals.​phaseTotals.​property name*number(float)additional property
totals.​fringeTotalsobjectrequired

Fringe benefit totals by phase ID. Keys follow same format as phaseTotals.

Example: {"estimate":2250,"actual":1875}
totals.​fringeTotals.​property name*number(float)additional property
totals.​actualTotalnumber(float)required

Total actual expenses for this tag across all phases

Example: 14375
Response
application/json
{
  "id": "Post-Production",
  "name": "Post-Production",
  "color": "#3B82F6",
  "description": "Post-production and VFX expenses",
  "totals": {
    "phaseTotals": { … },
    "fringeTotals": { … },
    "actualTotal": 14375
  }
}

Files

Upload receipts, contracts, and documents.
Attach files to actuals, POs, and projects.
Supports batch uploads and direct URL access.

Operations

Public Rates

Browse and use verified industry rate cards from the Saturation community.
Great for starting points or pricing validation.
Read-only access to rates from production companies, unions, and contractors.

Operations

Spaces

Group projects into folders for better organization.
Supports nested hierarchies (e.g., by client, year, or production type).

Operations

Comments

Add notes and discussions directly on budget lines.
Track approvals and changes with timestamps—context stays intact across phases.

Operations