Base URL
Every endpoint is served from a single base URL. Each path in this reference is relative to it.v1 segment is the API’s version. There is no version header or query parameter to send — configure the base URL once and you’re done. See Versioning and stability for the compatibility promises this carries.
Authentication
The API authenticates requests with a bearer token. Create a token from the API Access Tokens page in Contractors Cloud: log in and open Integrations → API Access Tokens. You choose the token’s name, so pick something that describes how it will be used, such aszapier, leads-form, or contact-integration.
The API Access Tokens page requires API access permissions on your user role. If you don’t see it, ask your administrator to grant you access.
Authorization header:
401 Unauthorized.
The API also supports OAuth 2.0 for platform and AI-agent integrations that connect on behalf of another user. AI agents connect this way through MCP.
Test your connection
Two quick checks get you from zero to a working integration. First, confirm you can reach the API — no token needed:me as the user id:
200 response with your user details means you’re ready to make any request in this reference. See Get API status and Get user.
Headers
Send these headers with every request so the API returns and parses JSON correctly:Responses
All responses are JSON. Single-resource endpoints return the resource object directly. List endpoints return a paginated envelope with the records in adata array.
Successful requests return a 2xx status code. Validation failures return 422 Unprocessable Entity with an errors object that names each invalid field.
Status codes
The API uses standard HTTP status codes. Rely on the status code to determine whether a request succeeded rather than inspecting the response body.Use these docs from your AI agent
This documentation is also available as an MCP server, so coding agents like Claude Code and Cursor can search and read every page — the full API reference included — while you build your integration:Add to Claude
Opens claude.ai with the docs connector pre-filled — click Add and it’s ready to use, no sign-in required.
Next steps
Filtering and sorting
Narrow and order list results with
filter and sort.Relationships
Embed related resources and computed attributes with
include and append.Pagination
Page through large list responses.
Rate limiting
Understand request limits and how to stay within them.
Versioning and stability
The compatibility contract: what never changes and how deprecations work.
Webhooks
Receive event notifications at your own endpoint when data changes.
Leads
Receive inbound leads and convert them into projects.
Connect your AI agent
Let Claude, ChatGPT, or another AI agent work with your Contractors Cloud account.
OAuth
Build integrations that connect on behalf of a user with OAuth 2.0.