The Handoff API lets your own software read and write your Handoff projects, estimates, proposals, invoices, and contacts. You create an API key in Settings > Integrations & API keys, then send requests to https://api.handoff.ai/core.
Available on the Scale plan. You need permission to view Company settings. Works on desktop and in the mobile app.
Create an API key
Go to Settings > Integrations & API keys.
Select the API keys tab.
Select Create API key.
Enter a name for the key, such as "Zapier integration", then select Generate key.
Select Copy and store the key somewhere safe.
Anyone with the key can act on behalf of your organization, so share it only with services you trust.
The API keys tab lists each key's name, creation date, and last use, and lets you revoke a key. You can have up to 10 active keys, and each needs a unique name.
Make your first request
The API uses JSON over HTTPS.
Send your key in an X-API-Key header, or as a bearer token in the Authorization header. To check that a key works, call GET /me. The full list of endpoints is in the API reference.
What the Handoff API can do
Projects: create and delete projects, assign a client, update the name and status, read schedules, and create a project with an AI-generated estimate or from a document.
Estimates: build estimates with line items and sections, edit or delete items, read itemized breakdowns, manage payment schedules, and export to PDF or CSV.
Proposals: generate a proposal from an estimate, send it by email or SMS, and approve, decline, or cancel it.
Invoices: create itemized invoices from an estimate, edit them, and export to PDF or a receipt.
Contacts: create, edit, search, and look up client contacts.
Sync and content: read templates, daily logs, documents, expenses, comments, activities, and attachments, plus feeds of recent changes for projects, estimates, proposals, invoices, and contacts.
Common API questions
Why did my AI estimate not come back in the response? AI estimate generation runs in the background. You get an immediate acknowledgment, and the finished estimate arrives at your
callbackUrlin about 1 to 5 minutes.Why are my dollar amounts 100 times too large? Money values are integer US cents, so $1,250.00 is
125000.
If you do not write code, you can connect Handoff to other apps with Zapier instead. See How to connect Handoff to Zapier.