Developers

Endpoint reference

Every REST endpoint, generated from the same route table and schemas the API validates with. Paths are relative to /api/v1.

Summary

Method and path	Scope
`GET /me`	Any one scope.
`GET /projects`	projects:read
`GET /projects/{id}`	projects:read
`GET /projects/{id}/links`	projects:read
`POST /projects`	projects:write
`PATCH /projects/{id}`	projects:write
`POST /projects/{id}/links`	links:write
`PATCH /links/{id}`	links:write
`DELETE /links/{id}`	links:write
`GET /projects/{id}/shoot-days`	schedule:read
`GET /shoot-days/{id}`	schedule:read
`GET /projects/{id}/deliverables`	deliverables:read
`GET /deliverables/{id}`	deliverables:read
`GET /deliverables/{id}/versions`	deliverables:read
`POST /projects/{id}/deliverables`	deliverables:write
`PATCH /deliverables/{id}`	deliverables:write
`POST /deliverables/{id}/versions`	deliverables:write
`GET /versions/{id}/notes`	deliverables:read
`POST /versions/{id}/notes`	deliverables:write
`GET /clients`	contacts:read
`GET /clients/{id}`	contacts:read
`GET /contacts`	contacts:read
`GET /contacts/{id}`	contacts:read
`GET /projects/{id}/locations`	locations:read
`GET /projects/{id}/crew`	crew:read
`GET /projects/{id}/media-drives`	media:read
`GET /webhook-endpoints`	webhooks:manage
`POST /webhook-endpoints`	webhooks:manage
`GET /webhook-endpoints/{id}`	webhooks:manage
`PATCH /webhook-endpoints/{id}`	webhooks:manage
`DELETE /webhook-endpoints/{id}`	webhooks:manage
`POST /webhook-endpoints/{id}/test`	webhooks:manage
`GET /openapi.json`	None. This document is public.

Every list is newest first and pages with a cursor. See Pagination and filters. Dates follow Dates and time zones. Writes take a JSON body, reject unknown fields, and accept an Idempotency-Key on every POST. See Retries and idempotency.

Workspace

`GET /me`

The workspace this token belongs to, its time zone, and the token's own scopes and expiry. A cheap way to check a token works.

Scope: Any one scope.

Field	Type	Description
`workspace`	object
`workspace.id`	string	Production Engine id.
`workspace.name`	string
`workspace.time_zone`	string	IANA zone shoot-day dates and call times are read in.
`token`	object
`token.id`	string	Production Engine id.
`token.name`	string
`token.scopes`	array of one of projects:read, projects:write, schedule:read, deliverables:read, deliverables:write, contacts:read, crew:read, locations:read, media:read, links:write, webhooks:manage
`token.expires_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/me \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "workspace": {
    "id": "cmexampletenant001",
    "name": "Eastside Pictures",
    "time_zone": "America/Los_Angeles"
  },
  "token": {
    "id": "cmexampletoken0001",
    "name": "Shade sync",
    "scopes": [
      "projects:read",
      "schedule:read",
      "deliverables:read"
    ],
    "expires_at": "2027-09-29T00:00:00.000Z"
  }
}

`GET /openapi.json`

This API as an OpenAPI 3.1 document, built from the same definitions as the routes. Public: no token needed.

Scope: None. This document is public.

Request

curl https://production-engine.com/api/v1/openapi.json

Projects and links

`GET /projects`

The workspace's projects, newest first. Deleted projects are never listed.

Scope: projects:read

Parameter	In	Type	Description
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.
`status`	query	one of ACTIVE, COMPLETE, ARCHIVED, pre_production, production, post_production, wrap, closed, archived	Only projects with this status.
`updated_since`	query	timestamp (UTC)	Only rows changed at or after this ISO 8601 instant.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`name`	string
`status`	one of ACTIVE, COMPLETE, ARCHIVED, pre_production, production, post_production, wrap, closed, archived
`phase`	one of brief, scope_bid, awarded, pre_pro, shoot, post, wrap, closed or null
`client_id`	string	Production Engine id.
`contact_id`	string or null	Production Engine id.
`description`	string or null
`agency`	string or null
`project_type`	string or null
`start_date`	date (YYYY-MM-DD) or null	First day of the job, YYYY-MM-DD.
`end_date`	date (YYYY-MM-DD) or null	Last day of the job, YYYY-MM-DD.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampleproject01",
      "name": "Spring Hero Spot",
      "status": "pre_production",
      "phase": "pre_pro",
      "client_id": "cmexampleclient001",
      "contact_id": "cmexamplecontact01",
      "description": "Two-day studio shoot for the spring launch.",
      "agency": null,
      "project_type": "Commercial",
      "start_date": "2026-11-02",
      "end_date": "2026-11-03",
      "created_at": "2026-09-14T15:02:11.000Z",
      "updated_at": "2026-09-28T19:40:03.000Z"
    }
  ],
  "next_cursor": "eyJjIjoiMjAyNi0wOS0xNFQxNTowMjoxMS4wMDBaIiwiaSI6ImNtZXhhbXBsZXByb2plY3QwMSJ9"
}

`GET /projects/{id}`

One project, with up to 100 of its external links.

Scope: projects:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`status`	one of ACTIVE, COMPLETE, ARCHIVED, pre_production, production, post_production, wrap, closed, archived
`phase`	one of brief, scope_bid, awarded, pre_pro, shoot, post, wrap, closed or null
`client_id`	string	Production Engine id.
`contact_id`	string or null	Production Engine id.
`description`	string or null
`agency`	string or null
`project_type`	string or null
`start_date`	date (YYYY-MM-DD) or null	First day of the job, YYYY-MM-DD.
`end_date`	date (YYYY-MM-DD) or null	Last day of the job, YYYY-MM-DD.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`external_links`	array	Up to 100 links, newest first. The links list pages through all of them.
`external_links[].id`	string	Production Engine id.
`external_links[].project_id`	string	Production Engine id.
`external_links[].deliverable_id`	string or null	Production Engine id.
`external_links[].provider`	string	Lowercase slug naming the other system, e.g. shade.
`external_links[].external_id`	string	The asset's id in the other system.
`external_links[].url`	string	https URL of the asset.
`external_links[].label`	string or null
`external_links[].metadata`	object or null	A JSON object set by whoever created the link.
`external_links[].created_via`	one of app, api, partner
`external_links[].created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`external_links[].updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexampleproject01",
  "name": "Spring Hero Spot",
  "status": "pre_production",
  "phase": "pre_pro",
  "client_id": "cmexampleclient001",
  "contact_id": "cmexamplecontact01",
  "description": "Two-day studio shoot for the spring launch.",
  "agency": null,
  "project_type": "Commercial",
  "start_date": "2026-11-02",
  "end_date": "2026-11-03",
  "created_at": "2026-09-14T15:02:11.000Z",
  "updated_at": "2026-09-28T19:40:03.000Z",
  "external_links": [
    {
      "id": "cmexamplelink00001",
      "project_id": "cmexampleproject01",
      "deliverable_id": null,
      "provider": "shade",
      "external_id": "drive_8f2k",
      "url": "https://app.shade.inc/example/drive_8f2k",
      "label": "Selects drive",
      "metadata": {
        "folder": "selects"
      },
      "created_via": "api",
      "created_at": "2026-09-20T17:00:00.000Z",
      "updated_at": "2026-09-20T17:00:00.000Z"
    }
  ]
}

`GET /projects/{id}/links`

Pointers from the project, or one of its deliverables, to assets in other systems.

Scope: projects:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`deliverable_id`	string or null	Production Engine id.
`provider`	string	Lowercase slug naming the other system, e.g. shade.
`external_id`	string	The asset's id in the other system.
`url`	string	https URL of the asset.
`label`	string or null
`metadata`	object or null	A JSON object set by whoever created the link.
`created_via`	one of app, api, partner
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01/links \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexamplelink00001",
      "project_id": "cmexampleproject01",
      "deliverable_id": null,
      "provider": "shade",
      "external_id": "drive_8f2k",
      "url": "https://app.shade.inc/example/drive_8f2k",
      "label": "Selects drive",
      "metadata": {
        "folder": "selects"
      },
      "created_via": "api",
      "created_at": "2026-09-20T17:00:00.000Z",
      "updated_at": "2026-09-20T17:00:00.000Z"
    }
  ],
  "next_cursor": null
}

`POST /projects`

Creates a project the way the app's New project form does: it gets its board, counts against the plan's active projects, and lands on the Unassigned client unless client_id names one. Logged in the project's activity as api:<token name>.

Scope: projects:write

Parameter	In	Type	Description
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Body field	Type	Description
`name`	string, required
`status`	one of pre_production, production, post_production, wrap, closed	Lifecycle status.
`phase`	one of brief, scope_bid, awarded, pre_pro, shoot, post, wrap, closed	Where the job is, from brief to closed. Setting a phase never closes the job; closing happens in Wrap.
`description`	string or null
`agency`	string or null
`project_type`	string or null
`start_date`	date (YYYY-MM-DD) or null	YYYY-MM-DD.
`end_date`	date (YYYY-MM-DD) or null	YYYY-MM-DD.
`client_id`	string	A client in this workspace. On create, omit it to use the workspace's Unassigned client.
`contact_id`	string or null	A client contact in this workspace, or null to clear it.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`status`	one of ACTIVE, COMPLETE, ARCHIVED, pre_production, production, post_production, wrap, closed, archived
`phase`	one of brief, scope_bid, awarded, pre_pro, shoot, post, wrap, closed or null
`client_id`	string	Production Engine id.
`contact_id`	string or null	Production Engine id.
`description`	string or null
`agency`	string or null
`project_type`	string or null
`start_date`	date (YYYY-MM-DD) or null	First day of the job, YYYY-MM-DD.
`end_date`	date (YYYY-MM-DD) or null	Last day of the job, YYYY-MM-DD.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X POST https://production-engine.com/api/v1/projects \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Fall Brand Film","phase":"brief","client_id":"cmexampleclient001","start_date":"2027-01-12","end_date":"2027-01-14"}'

Response

{
  "id": "cmexampleproject02",
  "name": "Fall Brand Film",
  "status": "pre_production",
  "phase": "brief",
  "client_id": "cmexampleclient001",
  "contact_id": null,
  "description": null,
  "agency": null,
  "project_type": null,
  "start_date": "2027-01-12",
  "end_date": "2027-01-14",
  "created_at": "2026-09-30T15:00:00.000Z",
  "updated_at": "2026-09-30T15:00:00.000Z"
}

`PATCH /projects/{id}`

Changes the fields sent and leaves the rest. A phase move is logged with the same guidance the app records. A project closed through Wrap answers 409 project_closed.

Scope: projects:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Body field	Type	Description
`name`	string
`status`	one of pre_production, production, post_production, wrap, closed	Lifecycle status.
`phase`	one of brief, scope_bid, awarded, pre_pro, shoot, post, wrap, closed	Where the job is, from brief to closed. Setting a phase never closes the job; closing happens in Wrap.
`description`	string or null
`agency`	string or null
`project_type`	string or null
`start_date`	date (YYYY-MM-DD) or null	YYYY-MM-DD.
`end_date`	date (YYYY-MM-DD) or null	YYYY-MM-DD.
`client_id`	string	A client in this workspace. On create, omit it to use the workspace's Unassigned client.
`contact_id`	string or null	A client contact in this workspace, or null to clear it.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`status`	one of ACTIVE, COMPLETE, ARCHIVED, pre_production, production, post_production, wrap, closed, archived
`phase`	one of brief, scope_bid, awarded, pre_pro, shoot, post, wrap, closed or null
`client_id`	string	Production Engine id.
`contact_id`	string or null	Production Engine id.
`description`	string or null
`agency`	string or null
`project_type`	string or null
`start_date`	date (YYYY-MM-DD) or null	First day of the job, YYYY-MM-DD.
`end_date`	date (YYYY-MM-DD) or null	Last day of the job, YYYY-MM-DD.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X PATCH https://production-engine.com/api/v1/projects/cmexampleproject01 \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"phase":"shoot","status":"production"}'

Response

{
  "id": "cmexampleproject01",
  "name": "Spring Hero Spot",
  "status": "production",
  "phase": "shoot",
  "client_id": "cmexampleclient001",
  "contact_id": "cmexamplecontact01",
  "description": "Two-day studio shoot for the spring launch.",
  "agency": null,
  "project_type": "Commercial",
  "start_date": "2026-11-02",
  "end_date": "2026-11-03",
  "created_at": "2026-09-14T15:02:11.000Z",
  "updated_at": "2026-09-30T15:05:00.000Z"
}

`POST /projects/{id}/links`

Points the project, or one of its deliverables, at an asset in your system. One link per provider and external_id on a project: a second answers 409 link_exists with the first one's id. The link shows on the project's Production Book.

Scope: links:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Body field	Type	Description
`provider`	string, required	Lowercase slug naming your system, e.g. shade.
`external_id`	string, required	The asset's id in your system.
`url`	string, required	https URL of the asset.
`label`	string or null
`metadata`	object or null	A JSON object of at most 4 KB. No credentials and no money.
`deliverable_id`	string or null	A deliverable on the same project, when the link is for one cut.

Field	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`deliverable_id`	string or null	Production Engine id.
`provider`	string	Lowercase slug naming the other system, e.g. shade.
`external_id`	string	The asset's id in the other system.
`url`	string	https URL of the asset.
`label`	string or null
`metadata`	object or null	A JSON object set by whoever created the link.
`created_via`	one of app, api, partner
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X POST https://production-engine.com/api/v1/projects/cmexampleproject01/links \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"provider":"shade","external_id":"drive_8f2k","url":"https://app.shade.inc/example/drive_8f2k","label":"Selects drive","metadata":{"folder":"selects"}}'

Response

{
  "id": "cmexamplelink00001",
  "project_id": "cmexampleproject01",
  "deliverable_id": null,
  "provider": "shade",
  "external_id": "drive_8f2k",
  "url": "https://app.shade.inc/example/drive_8f2k",
  "label": "Selects drive",
  "metadata": {
    "folder": "selects"
  },
  "created_via": "api",
  "created_at": "2026-09-20T17:00:00.000Z",
  "updated_at": "2026-09-20T17:00:00.000Z"
}

`PATCH /links/{id}`

Changes a link's url, label, metadata or deliverable. provider and external_id are fixed once made. Only the token that created the link can change it.

Scope: links:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Body field	Type	Description
`url`	string
`label`	string or null
`metadata`	object or null	A JSON object of at most 4 KB. No credentials and no money.
`deliverable_id`	string or null	A Production Engine id in this workspace.

Field	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`deliverable_id`	string or null	Production Engine id.
`provider`	string	Lowercase slug naming the other system, e.g. shade.
`external_id`	string	The asset's id in the other system.
`url`	string	https URL of the asset.
`label`	string or null
`metadata`	object or null	A JSON object set by whoever created the link.
`created_via`	one of app, api, partner
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X PATCH https://production-engine.com/api/v1/links/cmexamplelink00001 \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"label":"Final selects","metadata":{"folder":"final"}}'

Response

{
  "id": "cmexamplelink00001",
  "project_id": "cmexampleproject01",
  "deliverable_id": null,
  "provider": "shade",
  "external_id": "drive_8f2k",
  "url": "https://app.shade.inc/example/drive_8f2k",
  "label": "Final selects",
  "metadata": {
    "folder": "final"
  },
  "created_via": "api",
  "created_at": "2026-09-20T17:00:00.000Z",
  "updated_at": "2026-09-30T15:10:00.000Z"
}

`DELETE /links/{id}`

Removes a link. Only the token that created the link can delete it.

Scope: links:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`deleted`	boolean

Request

curl -X DELETE https://production-engine.com/api/v1/links/cmexamplelink00001 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexamplelink00001",
  "deleted": true
}

Shoot days

`GET /projects/{id}/shoot-days`

Each shoot day with its date, call and wrap times, location, hold status and call sheet status.

Scope: schedule:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.
`updated_since`	query	timestamp (UTC)	Only rows changed at or after this ISO 8601 instant.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`date`	date (YYYY-MM-DD)	The shoot date in the workspace time zone, YYYY-MM-DD.
`label`	string or null
`call_time`	string	General call, as entered (usually HH:MM), in the workspace time zone.
`wrap_time`	string or null
`hold_status`	one of pencil, first_hold, second_hold, confirmed, released
`time_zone`	string	IANA zone the date and times are in.
`location`	object
`location.id`	string or null	Production Engine id.
`location.name`	string or null
`location.address`	string or null
`call_sheet`	object or null	The day's call sheet, or null before one is made.
`call_sheet.id`	string	Production Engine id.
`call_sheet.status`	one of draft, sent, confirmed
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01/shoot-days \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampleshootday1",
      "project_id": "cmexampleproject01",
      "date": "2026-11-02",
      "label": "Day 1",
      "call_time": "07:00",
      "wrap_time": "19:00",
      "hold_status": "confirmed",
      "time_zone": "America/Los_Angeles",
      "location": {
        "id": "cmexamplelocation1",
        "name": "Eastside Stage",
        "address": "100 Main St, Austin, TX"
      },
      "call_sheet": {
        "id": "cmexamplecallsheet",
        "status": "sent"
      },
      "created_at": "2026-09-15T14:00:00.000Z",
      "updated_at": "2026-09-27T21:12:00.000Z"
    }
  ],
  "next_cursor": null
}

`GET /shoot-days/{id}`

One shoot day. With crew:read it also lists the crew calls on its call sheet.

Scope: schedule:read With crew:read as well, crew_calls is filled in; without it, crew_calls is null.

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`date`	date (YYYY-MM-DD)	The shoot date in the workspace time zone, YYYY-MM-DD.
`label`	string or null
`call_time`	string	General call, as entered (usually HH:MM), in the workspace time zone.
`wrap_time`	string or null
`hold_status`	one of pencil, first_hold, second_hold, confirmed, released
`time_zone`	string	IANA zone the date and times are in.
`location`	object
`location.id`	string or null	Production Engine id.
`location.name`	string or null
`location.address`	string or null
`call_sheet`	object or null	The day's call sheet, or null before one is made.
`call_sheet.id`	string	Production Engine id.
`call_sheet.status`	one of draft, sent, confirmed
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`crew_calls`	array or null	Crew calls from the day's call sheet. Null when the token lacks crew:read.
`crew_calls[].name`	string
`crew_calls[].role`	string
`crew_calls[].call_time`	string

Request

curl https://production-engine.com/api/v1/shoot-days/cmexampleshootday1 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexampleshootday1",
  "project_id": "cmexampleproject01",
  "date": "2026-11-02",
  "label": "Day 1",
  "call_time": "07:00",
  "wrap_time": "19:00",
  "hold_status": "confirmed",
  "time_zone": "America/Los_Angeles",
  "location": {
    "id": "cmexamplelocation1",
    "name": "Eastside Stage",
    "address": "100 Main St, Austin, TX"
  },
  "call_sheet": {
    "id": "cmexamplecallsheet",
    "status": "sent"
  },
  "created_at": "2026-09-15T14:00:00.000Z",
  "updated_at": "2026-09-27T21:12:00.000Z",
  "crew_calls": [
    {
      "name": "Dana Ruiz",
      "role": "Gaffer",
      "call_time": "06:30"
    },
    {
      "name": "Sam Ortiz",
      "role": "1st AC",
      "call_time": "06:45"
    }
  ]
}

Deliverables, versions and review notes

`GET /projects/{id}/deliverables`

The project's deliverables with status and due date.

Scope: deliverables:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.
`status`	query	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED	Only deliverables with this status.
`updated_since`	query	timestamp (UTC)	Only rows changed at or after this ISO 8601 instant.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`title`	string
`description`	string or null
`format`	string or null
`duration`	string or null
`platform`	string or null
`status`	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED
`due_date`	date (YYYY-MM-DD) or null	Calendar date, YYYY-MM-DD.
`delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`external_url`	string or null
`client_visible`	boolean
`sort_order`	integer
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01/deliverables \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampledeliver01",
      "project_id": "cmexampleproject01",
      "title": "Hero :30",
      "description": null,
      "format": "ProRes 422 HQ",
      "duration": ":30",
      "platform": "Broadcast",
      "status": "IN_REVIEW",
      "due_date": "2026-12-01",
      "delivered_at": null,
      "external_url": null,
      "client_visible": true,
      "sort_order": 0,
      "created_at": "2026-09-15T14:05:00.000Z",
      "updated_at": "2026-09-29T16:30:00.000Z"
    }
  ],
  "next_cursor": null
}

`GET /deliverables/{id}`

One deliverable, with a summary of its latest version and how many client-visible notes on it are still open.

Scope: deliverables:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`title`	string
`description`	string or null
`format`	string or null
`duration`	string or null
`platform`	string or null
`status`	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED
`due_date`	date (YYYY-MM-DD) or null	Calendar date, YYYY-MM-DD.
`delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`external_url`	string or null
`client_visible`	boolean
`sort_order`	integer
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`latest_version`	object or null
`latest_version.id`	string	Production Engine id.
`latest_version.version_number`	integer
`latest_version.kind`	one of upload, link
`latest_version.file_name`	string
`latest_version.decision`	one of PENDING, APPROVED, REVISION_REQUESTED
`latest_version.created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`open_note_count`	integer	Unresolved, client-visible top-level review notes on the latest version.

Request

curl https://production-engine.com/api/v1/deliverables/cmexampledeliver01 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexampledeliver01",
  "project_id": "cmexampleproject01",
  "title": "Hero :30",
  "description": null,
  "format": "ProRes 422 HQ",
  "duration": ":30",
  "platform": "Broadcast",
  "status": "IN_REVIEW",
  "due_date": "2026-12-01",
  "delivered_at": null,
  "external_url": null,
  "client_visible": true,
  "sort_order": 0,
  "created_at": "2026-09-15T14:05:00.000Z",
  "updated_at": "2026-09-29T16:30:00.000Z",
  "latest_version": {
    "id": "cmexampleversion01",
    "version_number": 2,
    "kind": "link",
    "file_name": "vimeo.com",
    "decision": "PENDING",
    "created_at": "2026-09-29T16:30:00.000Z"
  },
  "open_note_count": 3
}

`GET /deliverables/{id}/versions`

Every cut posted for review. An uploaded file's storage address is never returned; a link version returns its URL.

Scope: deliverables:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`deliverable_id`	string	Production Engine id.
`version_number`	integer
`kind`	one of upload, link	upload: a file stored in Production Engine. link: a cut on another site.
`file_name`	string
`external_url`	string or null	The cut's https URL for a link version; null for an upload.
`duration_ms`	integer or null
`width`	integer or null
`height`	integer or null
`decision`	one of PENDING, APPROVED, REVISION_REQUESTED
`decided_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/deliverables/cmexampledeliver01/versions \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampleversion01",
      "deliverable_id": "cmexampledeliver01",
      "version_number": 2,
      "kind": "link",
      "file_name": "vimeo.com",
      "external_url": "https://vimeo.com/123456789",
      "duration_ms": null,
      "width": null,
      "height": null,
      "decision": "PENDING",
      "decided_at": null,
      "created_at": "2026-09-29T16:30:00.000Z"
    }
  ],
  "next_cursor": null
}

`POST /projects/{id}/deliverables`

Adds a deliverable to the end of the project's list, as the app does.

Scope: deliverables:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Body field	Type	Description
`title`	string, required
`description`	string or null
`format`	string or null
`duration`	string or null
`platform`	string or null
`status`	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED	Where the deliverable is. Adding a version moves it to IN_REVIEW on its own.
`due_date`	date (YYYY-MM-DD) or null	YYYY-MM-DD.
`external_url`	string or null	An https link to the deliverable elsewhere.
`client_visible`	boolean	Whether the client sees it in their portal.

Field	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`title`	string
`description`	string or null
`format`	string or null
`duration`	string or null
`platform`	string or null
`status`	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED
`due_date`	date (YYYY-MM-DD) or null	Calendar date, YYYY-MM-DD.
`delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`external_url`	string or null
`client_visible`	boolean
`sort_order`	integer
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X POST https://production-engine.com/api/v1/projects/cmexampleproject01/deliverables \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Cutdown :15","duration":":15","platform":"Social","due_date":"2026-12-05"}'

Response

{
  "id": "cmexampledeliver02",
  "project_id": "cmexampleproject01",
  "title": "Cutdown :15",
  "description": null,
  "format": null,
  "duration": ":15",
  "platform": "Social",
  "status": "NOT_STARTED",
  "due_date": "2026-12-05",
  "delivered_at": null,
  "external_url": null,
  "client_visible": false,
  "sort_order": 1,
  "created_at": "2026-09-30T15:20:00.000Z",
  "updated_at": "2026-09-30T15:20:00.000Z"
}

`PATCH /deliverables/{id}`

Changes the fields sent. A status you set is kept as sent; adding a version is what moves a deliverable back to IN_REVIEW.

Scope: deliverables:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Body field	Type	Description
`title`	string
`description`	string or null
`format`	string or null
`duration`	string or null
`platform`	string or null
`status`	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED	Where the deliverable is. Adding a version moves it to IN_REVIEW on its own.
`due_date`	date (YYYY-MM-DD) or null	YYYY-MM-DD.
`external_url`	string or null	An https link to the deliverable elsewhere.
`client_visible`	boolean	Whether the client sees it in their portal.

Field	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`title`	string
`description`	string or null
`format`	string or null
`duration`	string or null
`platform`	string or null
`status`	one of NOT_STARTED, IN_PRODUCTION, IN_EDIT, IN_REVIEW, REVISION, APPROVED, DELIVERED
`due_date`	date (YYYY-MM-DD) or null	Calendar date, YYYY-MM-DD.
`delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`external_url`	string or null
`client_visible`	boolean
`sort_order`	integer
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X PATCH https://production-engine.com/api/v1/deliverables/cmexampledeliver01 \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"APPROVED"}'

Response

{
  "id": "cmexampledeliver01",
  "project_id": "cmexampleproject01",
  "title": "Hero :30",
  "description": null,
  "format": "ProRes 422 HQ",
  "duration": ":30",
  "platform": "Broadcast",
  "status": "APPROVED",
  "due_date": "2026-12-01",
  "delivered_at": null,
  "external_url": null,
  "client_visible": true,
  "sort_order": 0,
  "created_at": "2026-09-15T14:05:00.000Z",
  "updated_at": "2026-09-30T15:25:00.000Z"
}

`POST /deliverables/{id}/versions`

Posts a cut that lives on another site (Vimeo, YouTube or another https page) as the deliverable's next version, through the same code as the review room's Add a link. Open notes carry forward and the deliverable moves to IN_REVIEW.

Scope: deliverables:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Body field	Type	Description
`url`	string, required	The cut's https URL: Vimeo, YouTube or another page that can be framed.
`file_name`	string	What to call the cut. Defaults to the URL's host name.

Field	Type	Description
`id`	string	Production Engine id.
`deliverable_id`	string	Production Engine id.
`version_number`	integer
`kind`	one of upload, link	upload: a file stored in Production Engine. link: a cut on another site.
`file_name`	string
`external_url`	string or null	The cut's https URL for a link version; null for an upload.
`duration_ms`	integer or null
`width`	integer or null
`height`	integer or null
`decision`	one of PENDING, APPROVED, REVISION_REQUESTED
`decided_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X POST https://production-engine.com/api/v1/deliverables/cmexampledeliver01/versions \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://vimeo.com/987654321","file_name":"hero_v3.mov"}'

Response

{
  "id": "cmexampleversion02",
  "deliverable_id": "cmexampledeliver01",
  "version_number": 3,
  "kind": "link",
  "file_name": "hero_v3.mov",
  "external_url": "https://vimeo.com/987654321",
  "duration_ms": null,
  "width": null,
  "height": null,
  "decision": "PENDING",
  "decided_at": null,
  "created_at": "2026-09-30T15:30:00.000Z"
}

`GET /versions/{id}/notes`

Review notes and replies on one version. Internal team notes are never returned.

Scope: deliverables:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`version_id`	string	Production Engine id.
`parent_id`	string or null	The note this one replies to, or null.
`body`	string
`time_ms`	integer or null
`end_time_ms`	integer or null
`author_kind`	one of TEAM, CLIENT
`author_name`	string
`resolved_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/versions/cmexampleversion01/notes \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexamplenote00001",
      "version_id": "cmexampleversion01",
      "parent_id": null,
      "body": "Hold the logo two frames longer.",
      "time_ms": 27400,
      "end_time_ms": null,
      "author_kind": "CLIENT",
      "author_name": "Jordan (Brand)",
      "resolved_at": null,
      "created_at": "2026-09-29T18:02:00.000Z",
      "updated_at": "2026-09-29T18:02:00.000Z"
    }
  ],
  "next_cursor": null
}

`POST /versions/{id}/notes`

Adds a client-visible review note, or a reply to one, on a version. Notes written through the API are never internal.

Scope: deliverables:write

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Body field	Type	Description
`body`	string, required
`author_kind`	one of TEAM, CLIENT, required	TEAM for the production side, CLIENT for the client's reviewers.
`author_name`	string, required
`time_ms`	integer or null	Where in the cut the note sits, in milliseconds. Ignored on a link cut, as in the app.
`end_time_ms`	integer or null	End of a range, after time_ms.
`parent_id`	string	A top-level, client-visible note on the same version to reply to.

Field	Type	Description
`id`	string	Production Engine id.
`version_id`	string	Production Engine id.
`parent_id`	string or null	The note this one replies to, or null.
`body`	string
`time_ms`	integer or null
`end_time_ms`	integer or null
`author_kind`	one of TEAM, CLIENT
`author_name`	string
`resolved_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X POST https://production-engine.com/api/v1/versions/cmexampleversion01/notes \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"body":"Music swell lands late in the last shot.","author_kind":"CLIENT","author_name":"Jordan (Brand)"}'

Response

{
  "id": "cmexamplenote00002",
  "version_id": "cmexampleversion01",
  "parent_id": null,
  "body": "Music swell lands late in the last shot.",
  "time_ms": null,
  "end_time_ms": null,
  "author_kind": "CLIENT",
  "author_name": "Jordan (Brand)",
  "resolved_at": null,
  "created_at": "2026-09-30T15:35:00.000Z",
  "updated_at": "2026-09-30T15:35:00.000Z"
}

Clients and contacts

`GET /clients`

The workspace's clients, including its reserved Unassigned client.

Scope: contacts:read

Parameter	In	Type	Description
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.
`updated_since`	query	timestamp (UTC)	Only rows changed at or after this ISO 8601 instant.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`name`	string
`is_default`	boolean	True for the workspace's reserved Unassigned client.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/clients \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampleclient001",
      "name": "Acme Foods",
      "is_default": false,
      "created_at": "2026-08-01T12:00:00.000Z",
      "updated_at": "2026-09-10T12:00:00.000Z"
    }
  ],
  "next_cursor": null
}

`GET /clients/{id}`

One client.

Scope: contacts:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`is_default`	boolean	True for the workspace's reserved Unassigned client.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/clients/cmexampleclient001 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexampleclient001",
  "name": "Acme Foods",
  "is_default": false,
  "created_at": "2026-08-01T12:00:00.000Z",
  "updated_at": "2026-09-10T12:00:00.000Z"
}

`GET /contacts`

Client contacts with name, company, email, phone, role and stage. Deleted contacts are never listed.

Scope: contacts:read

Parameter	In	Type	Description
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.
`updated_since`	query	timestamp (UTC)	Only rows changed at or after this ISO 8601 instant.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`name`	string
`company`	string or null
`email`	string or null
`phone`	string or null
`role`	string or null
`client_id`	string or null	Production Engine id.
`stage`	one of lead, qualifying, active_contact, active_conversation, client_account, client_past, inactive_contact
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/contacts \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexamplecontact01",
      "name": "Jordan Lee",
      "company": "Acme Foods",
      "email": "jordan@acme.example",
      "phone": "512-555-0100",
      "role": "Brand manager",
      "client_id": "cmexampleclient001",
      "stage": "client_account",
      "created_at": "2026-08-01T12:00:00.000Z",
      "updated_at": "2026-09-10T12:00:00.000Z"
    }
  ],
  "next_cursor": null
}

`GET /contacts/{id}`

One client contact.

Scope: contacts:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`company`	string or null
`email`	string or null
`phone`	string or null
`role`	string or null
`client_id`	string or null	Production Engine id.
`stage`	one of lead, qualifying, active_contact, active_conversation, client_account, client_past, inactive_contact
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/contacts/cmexamplecontact01 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexamplecontact01",
  "name": "Jordan Lee",
  "company": "Acme Foods",
  "email": "jordan@acme.example",
  "phone": "512-555-0100",
  "role": "Brand manager",
  "client_id": "cmexampleclient001",
  "stage": "client_account",
  "created_at": "2026-08-01T12:00:00.000Z",
  "updated_at": "2026-09-10T12:00:00.000Z"
}

Locations

`GET /projects/{id}/locations`

The locations attached to a project, with address and status. Never the location's contact person or rate.

Scope: locations:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	The project location id.
`project_id`	string	Production Engine id.
`location_id`	string	The workspace location it points at.
`name`	string
`address`	string or null
`city`	string or null
`state`	string or null
`zip`	string or null
`role`	string or null	What the location is for on this job, e.g. Main set.
`status`	one of SCOUTING, HOLD, CONFIRMED, NEEDS_PERMIT, BLOCKED, RELEASED
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01/locations \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampleprojloc01",
      "project_id": "cmexampleproject01",
      "location_id": "cmexamplelocation1",
      "name": "Eastside Stage",
      "address": "100 Main St",
      "city": "Austin",
      "state": "TX",
      "zip": "78702",
      "role": "Main set",
      "status": "CONFIRMED",
      "created_at": "2026-09-16T10:00:00.000Z",
      "updated_at": "2026-09-20T10:00:00.000Z"
    }
  ],
  "next_cursor": null
}

Crew

`GET /projects/{id}/crew`

Name, role and booking status only. Never rates, start paperwork or contact details.

Scope: crew:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`name`	string
`role`	string
`booking_status`	one of suggested, held, booked, cancelled, paid or null

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01/crew \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexamplecrew00001",
      "name": "Dana Ruiz",
      "role": "Gaffer",
      "booking_status": "booked"
    }
  ],
  "next_cursor": null
}

Media drives

`GET /projects/{id}/media-drives`

Camera and backup drives logged on the project, with the shoot day they came from.

Scope: media:read

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`project_id`	string	Production Engine id.
`shoot_day_id`	string or null	Production Engine id.
`label`	string
`format`	string
`capacity`	string
`camera_source`	string
`backup_status`	one of PRIMARY, MIRRORED, SHIPPED, RECEIVED
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/projects/cmexampleproject01/media-drives \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexampledrive0001",
      "project_id": "cmexampleproject01",
      "shoot_day_id": "cmexampleshootday1",
      "label": "A001",
      "format": "SSD",
      "capacity": "2TB",
      "camera_source": "A camera",
      "backup_status": "MIRRORED",
      "created_at": "2026-11-02T23:10:00.000Z",
      "updated_at": "2026-11-03T01:00:00.000Z"
    }
  ],
  "next_cursor": null
}

Webhook endpoints

`GET /webhook-endpoints`

The webhook endpoints this token created, newest first. Endpoints made in Production Engine's settings, or by another token, are never listed.

Scope: webhooks:manage

Parameter	In	Type	Description
`limit`	query	string	Rows per page, 1 to 100. Default 25.
`cursor`	query	string	The next_cursor from the previous page. Omit it for the first page.

Field of each item in data	Type	Description
`id`	string	Production Engine id.
`name`	string
`url`	string	The https URL deliveries are posted to.
`events`	array of one of project_updated, deliverable_created, deliverable_status_changed, deliverable_version_created, review_note_created, schedule_day_created, schedule_day_updated
`enabled`	boolean	False while paused. A paused endpoint's queued deliveries are not sent.
`failing_since`	timestamp (UTC) or null	When a delivery last used up all its retries; null once one succeeds.
`last_delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/webhook-endpoints \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "data": [
    {
      "id": "cmexamplewebhook01",
      "name": "Shade review sync",
      "url": "https://hooks.shade.example/production-engine",
      "events": [
        "deliverable_status_changed",
        "deliverable_version_created",
        "project_updated",
        "schedule_day_updated"
      ],
      "enabled": true,
      "failing_since": null,
      "last_delivered_at": "2026-09-30T15:36:02.000Z",
      "created_at": "2026-09-30T15:00:00.000Z",
      "updated_at": "2026-09-30T15:00:00.000Z"
    }
  ],
  "next_cursor": null
}

`POST /webhook-endpoints`

Registers an https URL to receive signed deliveries for the events chosen. Only the seven REST events can be subscribed; money events and the other app-only events answer 422. Each event also needs the read scope for its record (projects:read for project_updated, deliverables:read for the deliverable and review note events, schedule:read for the shoot day events), or it answers 403 insufficient_scope. The response carries the whsec_ signing secret this once: store it now. A replay of the same Idempotency-Key returns the endpoint without it.

Scope: webhooks:manage

Parameter	In	Type	Description
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Body field	Type	Description
`name`	string, required	What to call the endpoint, shown in Production Engine's settings.
`url`	string, required	An https URL on a public address. Redirects are not followed.
`events`	array of one of project_updated, deliverable_created, deliverable_status_changed, deliverable_version_created, review_note_created, schedule_day_created, schedule_day_updated, required	The events to send. Duplicates are dropped.
`enabled`	boolean	False pauses deliveries; true resumes them.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`url`	string	The https URL deliveries are posted to.
`events`	array of one of project_updated, deliverable_created, deliverable_status_changed, deliverable_version_created, review_note_created, schedule_day_created, schedule_day_updated
`enabled`	boolean	False while paused. A paused endpoint's queued deliveries are not sent.
`failing_since`	timestamp (UTC) or null	When a delivery last used up all its retries; null once one succeeds.
`last_delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`secret`	string	The whsec_ signing secret, returned in this first response only. A replay of the same Idempotency-Key returns the endpoint without it.

Request

curl -X POST https://production-engine.com/api/v1/webhook-endpoints \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Shade review sync","url":"https://hooks.shade.example/production-engine","events":["deliverable_status_changed","deliverable_version_created","project_updated","schedule_day_updated"]}'

Response

{
  "id": "cmexamplewebhook01",
  "name": "Shade review sync",
  "url": "https://hooks.shade.example/production-engine",
  "events": [
    "deliverable_status_changed",
    "deliverable_version_created",
    "project_updated",
    "schedule_day_updated"
  ],
  "enabled": true,
  "failing_since": null,
  "last_delivered_at": null,
  "created_at": "2026-09-30T15:00:00.000Z",
  "updated_at": "2026-09-30T15:00:00.000Z",
  "secret": "whsec_example_2c1f0b7e9a4d4f7c8e6b1a3d"
}

`GET /webhook-endpoints/{id}`

One endpoint this token created. Any other endpoint answers 404.

Scope: webhooks:manage

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`url`	string	The https URL deliveries are posted to.
`events`	array of one of project_updated, deliverable_created, deliverable_status_changed, deliverable_version_created, review_note_created, schedule_day_created, schedule_day_updated
`enabled`	boolean	False while paused. A paused endpoint's queued deliveries are not sent.
`failing_since`	timestamp (UTC) or null	When a delivery last used up all its retries; null once one succeeds.
`last_delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl https://production-engine.com/api/v1/webhook-endpoints/cmexamplewebhook01 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexamplewebhook01",
  "name": "Shade review sync",
  "url": "https://hooks.shade.example/production-engine",
  "events": [
    "deliverable_status_changed",
    "deliverable_version_created",
    "project_updated",
    "schedule_day_updated"
  ],
  "enabled": true,
  "failing_since": null,
  "last_delivered_at": "2026-09-30T15:36:02.000Z",
  "created_at": "2026-09-30T15:00:00.000Z",
  "updated_at": "2026-09-30T15:00:00.000Z"
}

`PATCH /webhook-endpoints/{id}`

Pauses or resumes the endpoint (enabled), or changes its name, url or events. Resuming clears failing_since. The signing secret stays the same. Only the token that created the endpoint can change it.

Scope: webhooks:manage

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Body field	Type	Description
`name`	string	What to call the endpoint, shown in Production Engine's settings.
`url`	string	An https URL on a public address. Redirects are not followed.
`events`	array of one of project_updated, deliverable_created, deliverable_status_changed, deliverable_version_created, review_note_created, schedule_day_created, schedule_day_updated	The events to send. Duplicates are dropped.
`enabled`	boolean	False pauses deliveries; true resumes them.

Field	Type	Description
`id`	string	Production Engine id.
`name`	string
`url`	string	The https URL deliveries are posted to.
`events`	array of one of project_updated, deliverable_created, deliverable_status_changed, deliverable_version_created, review_note_created, schedule_day_created, schedule_day_updated
`enabled`	boolean	False while paused. A paused endpoint's queued deliveries are not sent.
`failing_since`	timestamp (UTC) or null	When a delivery last used up all its retries; null once one succeeds.
`last_delivered_at`	timestamp (UTC) or null	ISO 8601 instant in UTC.
`created_at`	timestamp (UTC)	ISO 8601 instant in UTC.
`updated_at`	timestamp (UTC)	ISO 8601 instant in UTC.

Request

curl -X PATCH https://production-engine.com/api/v1/webhook-endpoints/cmexamplewebhook01 \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

Response

{
  "id": "cmexamplewebhook01",
  "name": "Shade review sync",
  "url": "https://hooks.shade.example/production-engine",
  "events": [
    "deliverable_status_changed",
    "deliverable_version_created",
    "project_updated",
    "schedule_day_updated"
  ],
  "enabled": false,
  "failing_since": null,
  "last_delivered_at": "2026-09-30T15:36:02.000Z",
  "created_at": "2026-09-30T15:00:00.000Z",
  "updated_at": "2026-09-30T16:10:00.000Z"
}

`DELETE /webhook-endpoints/{id}`

Removes the endpoint and its queued deliveries. Only the token that created it can delete it.

Scope: webhooks:manage

Parameter	In	Type	Description
`id`	path, required	string	The record's id.

Field	Type	Description
`id`	string	Production Engine id.
`deleted`	boolean

Request

curl -X DELETE https://production-engine.com/api/v1/webhook-endpoints/cmexamplewebhook01 \
  -H "Authorization: Bearer $PE_TOKEN"

Response

{
  "id": "cmexamplewebhook01",
  "deleted": true
}

`POST /webhook-endpoints/{id}/test`

Posts a signed event named test, with an empty data object, to the endpoint now, outside the retry queue, and reports what your server answered. A receiver that fails is still a 200 here, with delivered false.

Scope: webhooks:manage

Parameter	In	Type	Description
`id`	path, required	string	The record's id.
`Idempotency-Key`	header	string	Up to 255 visible ASCII characters. A retry with the same key and body within 24 hours returns the first response instead of writing again.

Field	Type	Description
`delivered`	boolean	True when your server answered 2xx within 10 seconds.
`status_code`	integer or null	What your server answered, or null when it could not be reached.
`error`	string or null

Request

curl -X POST https://production-engine.com/api/v1/webhook-endpoints/cmexamplewebhook01/test \
  -H "Authorization: Bearer $PE_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Response

{
  "delivered": true,
  "status_code": 200,
  "error": null
}