Runs
Get a run
Returns one run: its status and, once it has finished, what it did. Pass the receipt a QuickBooks action returned.
- No daily limit.
- For assistants, the MCP tool get_event_status.
Request
curl https://api.clickr.cloud/v2/events/6729c1f04b7e3d0012a91e07 \
-H "Authorization: Bearer $CLICKR_API_KEY"const response = await fetch(`https://api.clickr.cloud/v2/events/6729c1f04b7e3d0012a91e07`, {
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/events/6729c1f04b7e3d0012a91e07",
headers={"Authorization": f"Bearer {os.environ['CLICKR_API_KEY']}"},
)
data = response.json()Response
{
"event": {
"_id": "6729c1f04b7e3d0012a91e07",
"type": "createProject",
"status": "successful",
"data": {
"projectId": "4821",
"name": "Henderson Residence Addition",
"status": "In progress",
"startDate": "11/10/2026",
"error": false
},
"createdAt": "2026-11-04T09:12:44.512Z"
}
}A run usually finishes in 3 to 5 minutes. Poll no more than once a minute, or pass a statusCallbackUrl to the action and Clickr will POST the result to you instead.
Path parameters
idstringRequiredThe run's id: the receipt from the action.
Response
200, as JSON.
eventobject_idstringThe run's id: the receipt its action returned.
typestringWhat the run does: createProject, updateProject, getProject, convertEstimateToInvoice or activateCustomer.
statusstringWhere the run is. Absent until a worker picks the run up, then processing, then successful, invalidInput (QuickBooks refused the input) or failed. queued appears when a run is retried.
One of queued, processing, successful, invalidInput, failed
dataobjectWhat the run did, once it has finished. Its fields depend on the type: see What a run returns.
createdAtstringWhen the run was started, in ISO 8601.
What a run returns
A finished run's data, by its type. A failed run carries error: true and an errorMessage instead.
createProject from Create a project
projectIdstringQuickBooks' id for the project.
receiptIdstringThe run's id, the same as its receipt.
namestringThe project's name.
statusstringThe project's status, as QuickBooks shows it.
startDatestringStart date.
endDatestringEnd date.
notesstringThe project's notes.
customFieldsarray of objectsThe project's custom fields, as title and value.
titlestringvaluestringerrorbooleanTrue when the run failed.
errorMessagestringWhy it failed.
updateProject from Update a project
projectIdstringQuickBooks' id for the project.
receiptIdstringThe run's id, the same as its receipt.
namestringThe project's name.
statusstringThe project's status, as QuickBooks shows it.
startDatestringStart date.
endDatestringEnd date.
notesstringThe project's notes.
customFieldsarray of objectsThe project's custom fields, as title and value.
titlestringvaluestringerrorbooleanTrue when the run failed.
errorMessagestringWhy it failed.
getProject from Get a project
projectIdstringQuickBooks' id for the project.
namestringThe project's name.
statusstringThe project's status.
startDatestringStart date.
endDatestringEnd date.
notesstringThe project's notes.
customFieldsarray of objectsThe project's custom fields, as title and value.
titlestringvaluestringconvertEstimateToInvoice from Convert an estimate to an invoice
txnIdstringThe estimate that was converted.
invoiceIdstringQuickBooks' id for the new invoice.
invoiceNumberstringThe new invoice's number.
activateCustomer from Activate a customer
customerIdstringThe customer that was activated.
displayNamestringThe customer's display name.
isActivebooleanWhether the customer is now active.
Errors
JSON with an error and, on most, a message saying what to change. All errors
| Status | Error | When |
|---|---|---|
| 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. |
| 404 | No event found | No run on the account has this id, or your access doesn't include its action. |
| 500 | Failed to get event | The id isn't a valid run id. |