Public API

Build on Finalizo.

Create projects, sync clients, send handover packs, and read sign-off state from your own tools.

Manage API keys API examples OpenAPI guide

API access requires an Agency plan and a scoped API key from Finalizo settings.

Bearer keys

Keys start with fz_live_ or fz_test_.

Scoped access

Use read, write, or admin scopes per key.

REST JSON

Most responses return data, meta, and error.

Automation

Use REST endpoints or Zapier polling routes.

Endpoint Reference

Base URL: https://finalizo.com/api/v1

GET/api/v1/openapi.jsonpublicDownload the OpenAPI 3.1 spec

GET/api/v1/authreadValidate an API key

GET/api/v1/mereadGet the authenticated workspace user

GET/api/v1/projectsreadList projects. Query: status, limit, cursor

POST/api/v1/projectswriteCreate a project and handover pack

GET/api/v1/projects/:idreadGet project details

PATCH/api/v1/projects/:idwriteUpdate project name, status, or launch date

GET/api/v1/projects/:id/packreadGet handover pack items, resources, terms, and masked credentials

POST/api/v1/projects/:id/pack/sendwriteMark the pack as sent and return the client URL

GET/api/v1/projects/:id/signoffreadGet sign-off status for a project

GET/api/v1/clientsreadList clients. Query: limit, cursor

POST/api/v1/clientswriteCreate or update a client by email

GET/api/v1/clients/:idreadGet a client and linked projects

GET/api/v1/signoffsreadList sign-offs. Query: status, limit, cursor

GET/api/v1/templatesreadList built-in handover templates

POST/api/v1/zapier/actions/create-projectwriteZapier action: create project

POST/api/v1/zapier/actions/send-packwriteZapier action: send pack

GET/api/v1/zapier/triggers/pack-sentreadZapier polling trigger: pack sent

GET/api/v1/zapier/triggers/pack-viewedreadZapier polling trigger: pack viewed

GET/api/v1/zapier/triggers/client-signed-offreadZapier polling trigger: client signed off

curl

curl https://finalizo.com/api/v1/projects \
  -H "Authorization: Bearer fz_live_your_key_here"

javascript

const response = await fetch("https://finalizo.com/api/v1/projects", {
  headers: { Authorization: "Bearer fz_live_your_key_here" }
});

const payload = await response.json();

createProject

curl https://finalizo.com/api/v1/projects \
  -X POST \
  -H "Authorization: Bearer fz_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Website closeout",
    "clientName": "Jane Smith",
    "clientEmail": "jane@example.com",
    "projectType": "Web Design",
    "launchDate": "2026-06-01"
  }'

zapierCreate

curl https://finalizo.com/api/v1/zapier/actions/create-project \
  -X POST \
  -H "Authorization: Bearer fz_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "project_name": "Website closeout",
    "client_name": "Jane Smith",
    "client_email": "jane@example.com",
    "project_type": "Web Design",
    "launch_date": "2026-06-01"
  }'

zapierSend

curl https://finalizo.com/api/v1/zapier/actions/send-pack \
  -X POST \
  -H "Authorization: Bearer fz_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "project_abc123",
    "personal_message": "The handover pack is ready for review."
  }'

Authentication

Generate keys in App Settings. Store the token once when it is created, then send it on every request.

Authorization: Bearer fz_live_your_key_here

Read endpoints need the read scope. Mutating endpoints need write or admin.

Read OpenAPI guide Download raw JSON

Errors

Standard API errors include a request ID. Use it when asking support to inspect a failed integration.

{
  "data": null,
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-05-27T12:00:00.000Z"
  },
  "error": {
    "code": "VALIDATION",
    "message": "Invalid request body.",
    "docs": "https://finalizo.com/developers#errors"
  }
}

Setting up an integration?

Create a dedicated API key, give it the narrowest scope required, then test with GET /auth before wiring production workflows.

Open API key settings

curl https://finalizo.com/api/v1/projects \ -X POST \ -H "Authorization: Bearer fz_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "name": "Website closeout", "clientName": "Jane Smith", "clientEmail": "jane@example.com", "projectType": "Web Design", "launchDate": "2026-06-01" }'

curl https://finalizo.com/api/v1/zapier/actions/create-project \ -X POST \ -H "Authorization: Bearer fz_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "project_name": "Website closeout", "client_name": "Jane Smith", "client_email": "jane@example.com", "project_type": "Web Design", "launch_date": "2026-06-01" }'

curl https://finalizo.com/api/v1/zapier/actions/send-pack \ -X POST \ -H "Authorization: Bearer fz_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "project_id": "project_abc123", "personal_message": "The handover pack is ready for review." }'

Errors

Standard API errors include a request ID. Use it when asking support to inspect a failed integration.

{ "data": null, "meta": { "request_id": "req_abc123", "timestamp": "2026-05-27T12:00:00.000Z" }, "error": { "code": "VALIDATION", "message": "Invalid request body.", "docs": "https://finalizo.com/developers#errors" } }