Skip to main content

Runs

Get a run

Returns one run: its status and, once it has finished, what it did. Pass the receipt a QuickBooks action returned.

GEThttps://api.clickr.cloud/v2/events/{id}
  • 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"

Response

200
{
  "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

idstringRequired

The run's id: the receipt from the action.

Response

200, as JSON.

eventobject
_idstring

The run's id: the receipt its action returned.

typestring

What the run does: createProject, updateProject, getProject, convertEstimateToInvoice or activateCustomer.

statusstring

Where 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

dataobject

What the run did, once it has finished. Its fields depend on the type: see What a run returns.

createdAtstring

When 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

projectIdstring

QuickBooks' id for the project.

receiptIdstring

The run's id, the same as its receipt.

namestring

The project's name.

statusstring

The project's status, as QuickBooks shows it.

startDatestring

Start date.

endDatestring

End date.

notesstring

The project's notes.

customFieldsarray of objects

The project's custom fields, as title and value.

titlestring
valuestring
errorboolean

True when the run failed.

errorMessagestring

Why it failed.

updateProject from Update a project

projectIdstring

QuickBooks' id for the project.

receiptIdstring

The run's id, the same as its receipt.

namestring

The project's name.

statusstring

The project's status, as QuickBooks shows it.

startDatestring

Start date.

endDatestring

End date.

notesstring

The project's notes.

customFieldsarray of objects

The project's custom fields, as title and value.

titlestring
valuestring
errorboolean

True when the run failed.

errorMessagestring

Why it failed.

getProject from Get a project

projectIdstring

QuickBooks' id for the project.

namestring

The project's name.

statusstring

The project's status.

startDatestring

Start date.

endDatestring

End date.

notesstring

The project's notes.

customFieldsarray of objects

The project's custom fields, as title and value.

titlestring
valuestring

convertEstimateToInvoice from Convert an estimate to an invoice

txnIdstring

The estimate that was converted.

invoiceIdstring

QuickBooks' id for the new invoice.

invoiceNumberstring

The new invoice's number.

activateCustomer from Activate a customer

customerIdstring

The customer that was activated.

displayNamestring

The customer's display name.

isActiveboolean

Whether the customer is now active.

Errors

JSON with an error and, on most, a message saying what to change. All errors

StatusErrorWhen
401No API Key providedThe Authorization header is missing.
401No account found for api key providedThe key isn't recognised: mistyped, revoked, or held by someone who has left the account.
401No integration found for accountThe account has no connector connected yet.
404No event foundNo run on the account has this id, or your access doesn't include its action.
500Failed to get eventThe id isn't a valid run id.