Skip to content
BuildWorkPro Docs

Overview

BuildWorkPro API 1.0.0

Section titled “ BuildWorkPro API 1.0.0 ”

Construction project management, CRM, and workflows — public REST API.

Information

Operations

Section titled “ Operations ”
GET
/contacts
POST
/contacts
POST
/contacts/get-many
GET
/contacts/count
GET
/contacts/summary
GET
/contacts/{id}
DELETE
/contacts/{id}
PATCH
/contacts/{id}
POST
/contacts/exports
POST
/contacts/imports
POST
/contacts/bulk
GET
/leads/summary
GET
/leads/count
GET
/leads
POST
/leads
GET
/leads/{id}
DELETE
/leads/{id}
PATCH
/leads/{id}
POST
/leads/{id}/convert
GET
/lead-stages
POST
/lead-stages
DELETE
/lead-stages/{id}
PATCH
/lead-stages/{id}
POST
/leads/exports
POST
/leads/imports
POST
/leads/bulk
GET
/bids
POST
/bids
GET
/bids/{id}
DELETE
/bids/{id}
PATCH
/bids/{id}
POST
/bids/{id}/send
POST
/bids/{id}/accept
POST
/bids/{id}/revert-acceptance
POST
/bids/{id}/reject
POST
/bids/{id}/duplicate
POST
/bids/{id}/convert-to-project
GET
/bids/{id}/line-items
POST
/bids/{id}/line-items
DELETE
/bids/{id}/line-items/{itemId}
PATCH
/bids/{id}/line-items/{itemId}
POST
/bids/exports
POST
/bids/bulk
POST
/bids/get-many
GET
/bids/count
GET
/bids/summary
POST
/bids/{id}/pdf
GET
/projects/count
GET
/projects/summary
POST
/projects/get-many
GET
/projects
POST
/projects
GET
/projects/{id}
DELETE
/projects/{id}
PATCH
/projects/{id}
POST
/projects/exports
POST
/projects/imports
POST
/projects/bulk
GET
/project-templates
POST
/project-templates
GET
/project-templates/{id}
DELETE
/project-templates/{id}
PATCH
/project-templates/{id}
GET
/change-orders/count
GET
/change-orders/summary
POST
/change-orders/get-many
GET
/change-orders
POST
/change-orders
GET
/change-orders/{id}
DELETE
/change-orders/{id}
PATCH
/change-orders/{id}
POST
/change-orders/{id}/submit
POST
/change-orders/{id}/approve
POST
/change-orders/{id}/reject
POST
/change-orders/exports
POST
/change-orders/bulk
POST
/change-orders/{id}/pdf
GET
/pay-apps/count
GET
/pay-apps/summary
POST
/pay-apps/get-many
GET
/pay-apps
POST
/pay-apps
GET
/pay-apps/{id}
DELETE
/pay-apps/{id}
PATCH
/pay-apps/{id}
POST
/pay-apps/{id}/submit
POST
/pay-apps/{id}/approve
POST
/pay-apps/{id}/reject
POST
/pay-apps/{id}/mark-paid
POST
/pay-apps/exports
POST
/pay-apps/bulk
POST
/pay-apps/{id}/pdf
GET
/invoices
POST
/invoices
GET
/invoices/summary
GET
/invoices/{id}
DELETE
/invoices/{id}
PATCH
/invoices/{id}
POST
/invoices/from-bid
POST
/invoices/from-pay-app
POST
/invoices/{id}/send
POST
/invoices/{id}/mark-sent
POST
/invoices/{id}/mark-paid
POST
/invoices/{id}/void
POST
/invoices/{id}/qbo/sync
GET
/invoices/{id}/payments
POST
/invoices/{id}/payments
DELETE
/invoices/{id}/payments/{paymentId}
PATCH
/invoices/{id}/payments/{paymentId}
POST
/invoices/{id}/lines
DELETE
/invoices/{id}/lines/{lineId}
PATCH
/invoices/{id}/lines/{lineId}
POST
/invoices/{id}/lines/reorder
GET
/invoices/{id}/pdf
GET
/site-logs
POST
/site-logs
GET
/site-logs/{id}
DELETE
/site-logs/{id}
PATCH
/site-logs/{id}
POST
/site-logs/exports
POST
/site-logs/imports
POST
/site-logs/bulk
GET
/time-entries
POST
/time-entries
DELETE
/time-entries/{id}
PATCH
/time-entries/{id}
POST
/time-entries/exports
POST
/time-entries/imports
POST
/time-entries/bulk
GET
/time-entries/summary
GET
/products
POST
/products
GET
/products/count
GET
/products/{id}
DELETE
/products/{id}
PATCH
/products/{id}
GET
/products/{id}/kit-items
POST
/products/{id}/kit-items
DELETE
/products/{id}/kit-items/{itemId}
PATCH
/products/{id}/kit-items/{itemId}
POST
/products/exports
POST
/products/imports
POST
/products/bulk
POST
/products/get-many
GET
/products/{id}/usage
POST
/products/{id}/restore
POST
/products/{id}/duplicate
POST
/products/bulk-delete
POST
/products/bulk-restore
PUT
/products/{id}/kit-items/reorder
GET
/documents/count
GET
/documents
GET
/documents/{id}
DELETE
/documents/{id}
PATCH
/documents/{id}
GET
/documents/{id}/download
POST
/documents/exports
POST
/documents/bulk
GET
/calendar/events
GET
/comments/{entityType}/{entityId}
POST
/comments
DELETE
/comments/{id}
PATCH
/comments/{id}
GET
/notifications
GET
/users
GET
/users/{id}
GET
/settings/branding
GET
/settings/data-retention
GET
/signature-requests
GET
/signature-requests/{id}
POST
/signature-requests/{id}/resend
POST
/signature-requests/{id}/void
GET
/webhook-endpoints
POST
/webhook-endpoints
GET
/webhook-endpoints/{id}
DELETE
/webhook-endpoints/{id}
PATCH
/webhook-endpoints/{id}
POST
/webhook-endpoints/{id}/rotate-secret
GET
/webhook-endpoints/{id}/deliveries
GET
/webhook-deliveries
GET
/webhook-deliveries/{id}
POST
/webhook-deliveries/{id}/replay
GET
/jobs
GET
/jobs/{id}
DELETE
/jobs/{id}
GET
/jobs/{id}/download
GET
/jobs/{id}/errors
POST
/jobs/{id}/cancel
POST
/jobs/uploads
GET
/api-audit-logs
GET
/usage
GET
/oauth/authorize
POST
/oauth/authorize
POST
/oauth/token
POST
/oauth/revoke
GET
/oauth/userinfo
POST
/oauth/register

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “ bearerAuth ”

Long-lived tenant-wide API key. Provision in Settings → Developer → API Keys.

Security scheme type: http

Bearer format: bwp_live_... or bwp_test_...

oauth2

Section titled “ oauth2 ”

OAuth 2.1 per-user token. Available in Phase 4.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://app.buildworkpro.com/api/v1/oauth/authorize

Token URL: https://app.buildworkpro.com/api/v1/oauth/token

Refresh URL: https://app.buildworkpro.com/api/v1/oauth/token