Documentation Hub
Your launch hub for product guides, implementation resources, and API references that keep every ContractShield rollout on track.
What's inside
I ship new playbooks, integration guides, and downloadable assets every release cycle so you stay current.
Quickstart guides
Spin up your workspace, import historical estimates, and get crews collaborating in under an hour.
API reference
REST endpoints, TypeScript SDKs, and webhook schemas that mirror the production ContractShield platform.
Configuration playbooks
Role-based templates for approvals, safety checklists, and change-order governance.
Implementation toolkit
Configure your workspace with best practices for permissions, project templates, and automation.
- • Sample data import CSVs
- • Field training slide decks
- • Security & compliance checklist
First-time setup checklist
Self-serve guides walk through workspace setup, permissions, and your first projects in under 30 minutes — no calls required.
Open checklistVersioning
The API follows semantic versioning. Subscribe to changelog updates or pin to a version to control rollouts.
Browse all guides
Every published guide and reference, in one place.
First-time setup
Spin up your workspace, invite your team, and ship your first project under 30 minutes.
Generating your first quote
Walk through the AI-assisted quote builder from labor + materials to client-ready PDF.
Quote workflow
End-to-end map of submission, revisions, approvals, and acceptance handoff to a project.
Client quote approval
How clients review competing bids, request changes, and accept a quote on their portal.
Pricing templates
Reusable line-item bundles for trades, materials, and markups across recurring jobs.
Embed forms
Drop a hosted intake form on your own marketing site to capture work orders directly.
Procore integration
Sync projects, RFIs, and submittals between ContractShield and Procore.
QuickBooks integration
Push invoices and payments from ContractShield into QuickBooks Online with one click.
API reference
REST endpoints, TypeScript SDKs, and webhook schemas mirroring the production platform.
Contractor dashboard
What every widget does, when to reach for it, and how to customize layout to match how you work.
Job Board — the marketplace
Filter strategy, listing-to-bid workflow, and how to win work without the race-to-the-bottom on price.
Project hub
Six tabs (Tasks, Timeline, Time tracking, Materials, Photos, Payments). What each shows, when to use it.
Invoicing clients
Drafting from milestones, line items, sending, payment tracking. Includes 2% platform fee structure.
How payouts work
Plain-English walk-through of charge → pending payout → 7-day grace → bank deposit, plus exactly what happens on a refund or chargeback.
Team & verification
Inviting subcontractors, role assignments, and the 5-tier verification ladder up to verified_pro.
Client dashboard
Active projects, pending approvals, recent activity, and quick actions — your daily view.
Posting a work order
Step-by-step on writing the title, scope, photos, and budget so you get strong bids fast.
Reviewing & comparing quotes
Apples-to-apples comparison, decision framework, and how to evaluate without anchoring on price.
My approvals
Side-by-side bid comparison, contractor reputation, accept/reject workflow.
My projects & contracts
Tracking active projects, viewing contract documents, signing flow, milestone progress.
AI assistant
What the assistant can do, how to talk to it, and the safety guarantees that make actions safe to delegate.
Chat & messaging
Quote messages, work-order messages, the Chat Hub. When to use which thread.
Change orders
Mid-project scope changes, approval flow, dollar + schedule impact, common scenarios.
Reviews & ratings
5-dimension review system, how reviews aggregate, impact on contractor verification tier.
Postman collection
Test endpoints quickly with environments for sandbox and production.
Changelog
Track product updates and API version releases in real time.
Status page
Subscribe to incident updates and maintenance notifications.
Can't find what you need?
Message me directly or reach out to support for deep-dive guidance.