QuickBooks
Get a project
Reads a QuickBooks project's name, status, dates, notes and custom fields, by its id or its name.
GEThttps://api.clickr.cloud/ v2/ integrations/ quickbooks/ projects
- Uses 1 run: 100 a day on Standard, 500 on Velocity, reset at midnight UTC.
- On Standard, 1 call every 30 seconds across the Projects endpoints.
- Also served at
/integrations/quickbooks/projects, for older integrations. - For assistants, the MCP tool get_quickbooks_project.
Request
curl -G https://api.clickr.cloud/v2/integrations/quickbooks/projects \
-H "Authorization: Bearer $CLICKR_API_KEY" \
--data-urlencode "projectName=Henderson Residence Addition" \
--data-urlencode "callbackUrl=https://example.com/clickr/runs"const response = await fetch(`https://api.clickr.cloud/v2/integrations/quickbooks/projects?${new URLSearchParams({
"projectName": "Henderson Residence Addition",
"callbackUrl": "https://example.com/clickr/runs"
})}`, {
headers: {
Authorization: `Bearer ${process.env.CLICKR_API_KEY}`,
},
});
const data = await response.json();import os
import requests
response = requests.get(
"https://api.clickr.cloud/v2/integrations/quickbooks/projects",
headers={"Authorization": f"Bearer {os.environ['CLICKR_API_KEY']}"},
params={
"projectName": "Henderson Residence Addition",
"callbackUrl": "https://example.com/clickr/runs"
},
)
data = response.json()Response
200
{
"receipt": "6729c1f04b7e3d0012a91e07"
}Like the other QuickBooks actions this starts a run, so the project arrives in the run's data, not in this response. callbackUrl is required.
Query parameters
projectIdstringQuickBooks' id for the project. Give this or projectName.
projectNamestringThe project's name. Give this or projectId.
callbackUrlstringRequiredA URL Clickr POSTs the project to when the run finishes.
Response
200, as JSON, once the run is queued. What the run did comes from Get a run, or is POSTed to your statusCallbackUrl.
receiptstringThe id of the run this call started. Pass it to Get a run.
Errors
JSON with an error and, on most, a message saying what to change. All errors
| Status | Error | When |
|---|---|---|
| 400 | Must include projectId or projectName in the query string | Neither was given. |
| 400 | Must include callbackUrl in the query string | callbackUrl is missing. |
| 401 | No API Key provided | The Authorization header is missing. |
| 401 | No account found for api key provided | The key isn't recognised: mistyped, revoked, or held by someone who has left the account. |
| 401 | No integration found for account | The account has no connector connected yet. |
| 401 | This integration is still pending setup… | QuickBooks isn't fully set up in Clickr: its sign-in or two-factor setup is unfinished. The error says what to do. |
| 403 | Forbidden | Your access on the account doesn't include this action. |
| 403 | Daily cap exceeded | The account has used its runs for the day: 100 on Standard, 500 on Velocity. They reset at midnight UTC. |
| 403 | Rate limit exceeded | A second call within 30 seconds on Standard. Velocity has no wait. |