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

List workspace rates

Request

Retrieve all rates from the workspace

Security
ApiKeyAuth
Query
expandsArray of strings

Expand related data in the response

Items Value"contact"
Example: expands=contact
searchstring

Search rates by name, description, or note

Example: search=camera
limitinteger[ 1 .. 1000 ]

Maximum number of results to return

Default 100
Example: limit=50
offsetinteger>= 0

Number of results to skip for pagination

Default 0
curl -i -X GET \
  'https://api.saturation.io/api/v1/rates?expands=contact&search=camera&limit=50&offset=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of workspace rates

Bodyapplication/json
ratesArray of objects(Rate)
Response
application/json
{
  "rates": [
    { … }
  ]
}

Create workspace rate

Request

Create a new rate in the workspace

Security
ApiKeyAuth
Bodyapplication/jsonrequired
namestring

Rate name

Example: "Director of Photography"
emojistring

Rate emoji or icon

Example: "👨‍💻"
descriptionstring

Rate description

Example: "Cinematography and camera operation"
notestring

Additional notes

Example: "Includes equipment setup and operation"
quantitynumber

Rate quantity

Example: 40
ratenumber

Rate or cost

Example: 175
unitstring

Unit of measurement

Enum"hour""day""week""month""year""each""sqft""sqm""lnft""lnm"
Example: "hour"
multipliernumber

Rate multiplier

Example: 1.5
contactIdstring

Associated contact ID

Example: "contact-dp-001"
curl -i -X POST \
  https://api.saturation.io/api/v1/rates \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Director of Photography",
    "emoji": "👨‍💻",
    "description": "Cinematography and camera operation",
    "note": "Includes equipment setup and operation",
    "quantity": 40,
    "rate": 175,
    "unit": "hour",
    "multiplier": 1.5,
    "contactId": "contact-dp-001"
  }'

Responses

Rate created successfully

Bodyapplication/json
idstringrequired

Unique item identifier

Example: "item-001"
namestring or null

Item display name

Example: "Director of Photography"
emojistring or null

Item emoji or icon

Example: "👨‍💻"
descriptionstring or null

Item description

Example: "Cinematography and camera operation"
notestring or null

Additional notes about the item

Example: "Includes equipment setup and operation"
quantitynumber or null

Item quantity

Example: 40
ratenumber or null

Item rate or cost per unit

Example: 175
unitstring or null

Unit of measurement

Enum"hour""day""week""month""year""each""sqft""sqm""lnft""lnm"
Example: "hour"
multipliernumber or null

Rate multiplier

Example: 1.5
contactIdstring or null

Associated contact ID

Example: "contact-dp-001"
contactobject(Contact)
Response
application/json
{
  "id": "item-001",
  "name": "Director of Photography",
  "emoji": "👨‍💻",
  "description": "Cinematography and camera operation",
  "note": "Includes equipment setup and operation",
  "quantity": 40,
  "rate": 175,
  "unit": "hour",
  "multiplier": 1.5,
  "contactId": "contact-dp-001",
  "contact": {
    "id": "contact-studio-001",
    "contactTitle": "Sunset Studios - Production Company",
    "name": "Alex Rivera",
    "email": "alex.rivera@sunsetstudios.com",
    "company": "Sunset Studios Inc.",
    "type": "Person",
    "jobTitle": "Director of Photography",
    "rate": 150,
    "secureInfo": { … },
    "origin": { … },
    "startwork": [ … ],
    "linkedUser": { … },
    "bankInfo": [ … ],
    "taxDocuments": [ … ],
    "attachments": [ … ],
    "projects": { … }
  }
}

Update workspace rate

Request

Update a rate in the workspace

Security
ApiKeyAuth
Path
rateIdstringrequired

Rate identifier

Example: item-001
Bodyapplication/jsonrequired
namestring

Updated rate name

Example: "Gaffer"
emojistring

Updated rate emoji or icon

Example: "🚀"
descriptionstring

Updated rate description

Example: "Lighting design and electrical department head"
notestring

Updated additional notes

Example: "Includes lighting design, crew management, power distribution"
quantitynumber

Updated rate quantity

Example: 50
ratenumber

Updated rate or cost

Example: 200
unitstring

Updated unit of measurement

Enum"hour""day""week""month""year""each""sqft""sqm""lnft""lnm"
Example: "hour"
multipliernumber

Updated rate multiplier

Example: 1.75
contactIdstring

Updated associated contact/vendor ID

Example: "contact-gaffer-001"
curl -i -X PUT \
  https://api.saturation.io/api/v1/rates/item-001 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Gaffer",
    "emoji": "🚀",
    "description": "Lighting design and electrical department head",
    "note": "Includes lighting design, crew management, power distribution",
    "quantity": 50,
    "rate": 200,
    "unit": "hour",
    "multiplier": 1.75,
    "contactId": "contact-gaffer-001"
  }'

Responses

Rate updated successfully

Bodyapplication/json
idstringrequired

Unique item identifier

Example: "item-001"
namestring or null

Item display name

Example: "Director of Photography"
emojistring or null

Item emoji or icon

Example: "👨‍💻"
descriptionstring or null

Item description

Example: "Cinematography and camera operation"
notestring or null

Additional notes about the item

Example: "Includes equipment setup and operation"
quantitynumber or null

Item quantity

Example: 40
ratenumber or null

Item rate or cost per unit

Example: 175
unitstring or null

Unit of measurement

Enum"hour""day""week""month""year""each""sqft""sqm""lnft""lnm"
Example: "hour"
multipliernumber or null

Rate multiplier

Example: 1.5
contactIdstring or null

Associated contact ID

Example: "contact-dp-001"
contactobject(Contact)
Response
application/json
{
  "id": "item-001",
  "name": "Director of Photography",
  "emoji": "👨‍💻",
  "description": "Cinematography and camera operation",
  "note": "Includes equipment setup and operation",
  "quantity": 40,
  "rate": 175,
  "unit": "hour",
  "multiplier": 1.5,
  "contactId": "contact-dp-001",
  "contact": {
    "id": "contact-studio-001",
    "contactTitle": "Sunset Studios - Production Company",
    "name": "Alex Rivera",
    "email": "alex.rivera@sunsetstudios.com",
    "company": "Sunset Studios Inc.",
    "type": "Person",
    "jobTitle": "Director of Photography",
    "rate": 150,
    "secureInfo": { … },
    "origin": { … },
    "startwork": [ … ],
    "linkedUser": { … },
    "bankInfo": [ … ],
    "taxDocuments": [ … ],
    "attachments": [ … ],
    "projects": { … }
  }
}

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

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