API Documentation

Public REST API for film projects, financing, and submissions. JSON in, JSON out. The machine-readable schema lives at /api/v1/openapi.json (OpenAPI 3.1).

Basics

Projects

GET/projectsList projects
POST/projectsCreate a project
GET/projects/{id}Get a project
PATCH/projects/{id}Update a project
DELETE/projects/{id}Delete a project

Parties

GET/partiesList financing parties
POST/partiesCreate a party
GET/parties/{id}Get a party
PATCH/parties/{id}Update a party
DELETE/parties/{id}Delete a party

Participants

GET/projects/{projectId}/participantsList participants
POST/projects/{projectId}/participantsAdd a participant
PATCH/projects/{projectId}/participants/{pcpId}Update a participant
DELETE/projects/{projectId}/participants/{pcpId}Remove a participant

Soft Money

GET/soft-money/schemesList rebate / incentive schemes
GET/projects/{projectId}/soft-money-claimsList claims for a project
POST/projects/{projectId}/soft-money-claimsCreate a claim
PATCH/projects/{projectId}/soft-money-claims/{claimId}Update a claim
DELETE/projects/{projectId}/soft-money-claims/{claimId}Delete a claim

Cash Flow

GET/projects/{projectId}/cash-flowGet the cash-flow timeline
POST/projects/{projectId}/cash-flowAdd a cash-flow item
PATCH/projects/{projectId}/cash-flow/{itemId}Update an item
DELETE/projects/{projectId}/cash-flow/{itemId}Delete an item
POST/projects/{projectId}/cash-flow/seedSeed a default timeline

Submissions

GET/submissionsList submissions
GET/submissions/overdueList overdue submissions
GET/submissions/by-project/{projectId}List submissions for a project
PATCH/submissions/{accessKeyId}/statusUpdate submission status
DELETE/submissions/{accessKeyId}/statusClear status overlay

Machine-readable