Skip to content
BuildWorkPro Docs
Search
Ctrl
K
Cancel
Email Support
Select theme
Dark
Light
Auto
Getting Started
What is BuildWorkPro?
Quick Start
Your Dashboard
Navigation and Search
Your First Project
Bids & Estimates
Creating a Bid
Line Items
Rates
Project Costs
Sending a Bid
Bid Templates
PDF and Duplication
Products & Catalog
Product Catalog
Product Kits
Project Management
Projects Overview
Phases and Tasks
Gantt Chart
Project Templates
Documents, Comments, and Activity
Pay Applications
Creating a Pay App
Schedule of Values
Approval Workflow
PDF and Email
Change Orders
Creating a Change Order
Change Order Approval
Field Operations
Site Logs
Time Tracking
CRM & Pipeline
Contacts
Sales Pipeline
Leads
Documents
Document Library
CSV Import Templates
Reports
Reports
Calendar
Calendar
Account & Settings
Profile and Security
Notifications
Company Profile
Team and Roles
Billing and Plans
Sales and Document Settings
Integrations
Connect Google (Gmail and Calendar)
Import & Export
Deleted Records
Developers
Overview
Quickstart
Authentication
API Keys
OAuth 2.1
Concepts
Errors
Idempotency
Pagination
Rate Limits
Scopes
Webhooks
Event Catalog
Webhooks Overview
Verifying Signatures
Testing Webhooks Locally
MCP (AI agents)
Install in ChatGPT
Install in Claude Code
Install in Claude Desktop
Install in Grok Bot
Install in Hermes Agent
Install in OpenClaw
MCP — Use BuildWorkPro from your AI agent
Tools Catalog
Recipes
Sync to Google Calendar
Bulk Update Project Status
React When a Bid Is Accepted
Attach a Document to a Bid
Generate Change Orders from a Spreadsheet
Sync Leads from Your Website Form
Ask Claude to Draft a Bid Follow-Up
Have ChatGPT Summarize Your Open Projects
Changelog
API Reference
Overview
Contacts
Overview
List contacts
Create contact
Bulk-fetch contacts by ID
Count contacts
Aggregate contact totals and breakdown by type
Get contact by id
Delete contact
Update contact
Start CSV export of contacts
Start CSV import of contacts
Start bulk operation on contacts
Leads
Overview
Aggregate lead totals and breakdowns by stage and source
Count leads
List leads
Create lead
Get lead by id
Delete lead
Update lead
Convert lead to project
List lead stages
Create lead stage
Delete lead stage
Update lead stage
Start CSV export of leads
Start CSV import of leads
Start bulk operation on leads
Bids
Overview
List bids
Create bid
Get bid by id
Delete bid
Update bid
Send a bid to the customer
Create a public share link for a bid
Accept a bid
Revert acceptance of a bid
Reject a bid
Duplicate a bid
Convert accepted bid to project
List bid line items
Create bid line item
Delete bid line item
Update bid line item
Start CSV export of bids
Start bulk operation on bids
Bulk-fetch bids by ID
Count bids
Aggregate bid totals and breakdown by status
Generate PDF for a bid (async)
Projects
Overview
Count the records still attached to a project
Read a soft-deleted project
Move every record off a project
Count projects
Aggregate project totals and breakdowns by status and type
Bulk-fetch projects by ID
List projects
Create project
Get project by id
Delete project
Update project
Start CSV export of projects
Start CSV import of projects
Start bulk operation on projects
ProjectTemplates
Overview
List project templates
Create project template
Get project template by id
Delete project template
Update project template
Reports
Overview
List the reports available to the caller
Business review — Sold, Billed, Collected, Owed vs the prior period
Run a catalog report
ChangeOrders
Overview
Move a change order to another project
Count change orders
Aggregate change order totals and breakdown by status
Bulk-fetch change orders by ID
List change orders
Create change order
Get change order by id
Delete change order
Update draft change order
Submit change order for approval
Approve change order
Reject change order
Start CSV export of change orders
Start bulk operation on change orders
Generate PDF for a change order (async)
Email a change order to the customer
PayApps
Overview
Count pay applications
Aggregate pay-app totals and breakdown by status
Bulk-fetch pay apps by ID
List pay applications
Create pay application (draft)
Get pay application by id
Delete draft pay application
Update draft pay application
Submit pay app for approval
Approve pay application
Reject pay application
Mark approved pay app as paid
Start CSV export of pay applications
Start bulk operation on pay applications
Generate PDF for a pay application (async)
Email a pay application to the customer
Invoices
Overview
Move a invoice to another project
List invoices
Create an invoice
Aggregate invoice totals
Fetch an invoice
Soft-delete a draft invoice
Update a draft invoice
Create an invoice from a bid
Create an invoice from an approved pay application
Email the invoice and mark it sent
Mark an invoice sent without emailing it
Send an invoice from QuickBooks Online
Mark an invoice paid in full
Void an invoice
Link or unlink what an invoice bills
Queue a QuickBooks Online push
List the invoice's payment ledger
Record a manual payment
Void a manual payment
Edit a manual payment
Append a line item to a draft
Remove a line item
Update a line item
Reorder line items
Render the invoice as a PDF
SiteLogs
Overview
Move a site log to another project
List site logs
Create site log
Get site log by id
Delete site log
Update site log
Download a site log as a daily report PDF
Start CSV export of site logs
Start CSV import of site logs
Start bulk operation on site logs
TimeEntries
Overview
Move a time entry to another project
List time entries
Create time entry
Delete time entry
Update time entry
Start CSV export of time entries
Start CSV import of time entries
Start bulk operation on time entries
Aggregate time-entry metrics
CrewAssignments
Overview
List crew assignments
Get a crew assignment
Delete a crew assignment
Replace a job-day's crew
Briefing
Overview
Dismiss or snooze a briefing row
Undo a briefing dismissal
Products
Overview
List products
Create product
Count products
Get product by id
Delete product
Update product
List product kit items
Add product kit item
Remove kit item
Update a kit item
Start CSV export of products
Start CSV import of products
Start bulk operation on products
Bulk-fetch products by ID
Product usage counts
Restore a soft-deleted product
Duplicate a product
Bulk soft-delete products
Bulk restore products
Reorder kit items
Documents
Overview
Count documents
List documents
Get document metadata
Delete document (soft)
Update document metadata
Download document file
Start CSV export of documents
Start bulk operation on documents
Calendar
Overview
List calendar events
Search
Overview
Search across records
Comments
Overview
List comments on a record
Post a comment
Delete a comment
Edit a comment
Notifications
Overview
List notifications for the API key creator
Users
Overview
List users
Get user by id
Identify the caller
Settings
Overview
Get branding settings
Get data retention settings
SignatureRequests
Overview
List e-signature requests
Get an e-signature request
Resend an e-signature request
Void an e-signature request
Webhooks
Overview
List webhook endpoints
Create webhook endpoint
Get webhook endpoint
Delete webhook endpoint
Update webhook endpoint
Rotate webhook signing secret
List recent deliveries for an endpoint
List webhook deliveries (tenant-wide)
Get webhook delivery
Replay webhook delivery
Jobs
Overview
List async jobs
Get job by id
Soft-delete job
Download job result artifact
Download job errors artifact
Cancel job
Get signed URL for CSV upload
Observability
Overview
List API audit log entries for the calling tenant
Get current rate-limit consumption
OAuth
Overview
OAuth 2.1 authorization endpoint (consent screen)
OAuth 2.1 consent decision
OAuth 2.1 token endpoint
OAuth 2.0 Token Revocation (RFC 7009)
OAuth/OpenID userinfo endpoint
Dynamic Client Registration (RFC 7591)
Email Support
Select theme
Dark
Light
Auto
Overview
Search
Section titled “ Search ”
One ranked search across records, limited to the types and rows the credential may read.
Operations
Section titled “ Operations ”
GET
/search
