Get started

Errors

An error comes back as JSON with an error naming what went wrong and, on most, a message saying what to change.

Response

400

{
  "error": "Invalid request",
  "message": "Unknown filter operator \"like\" for field \"jobName\". Valid operators: eq, ne, gt, gte, lt, lte, contains, in"
}

A request that fails its checks gets a different status on different endpoints today: 400, 401 or 500. Read error and message rather than the status alone. Each endpoint's page lists exactly what it returns.

Status codes

Status	Meaning
400	A parameter can't be read: a filter or sort on List records, or a missing one on Get a project.
401	The API key is missing or not recognised, the account has no connector yet, or QuickBooks setup is unfinished. Convert an estimate also answers 401 to a body that fails its checks.
403	Your access doesn't include the dataset or action, or a limit was reached: the day's runs, the wait between Projects calls, a scope or credits.
404	Nothing with that id on your account, or a download link that is no longer valid.
429	projectNameIdentifier was sent on Standard.
500	Create and Update a project answer 500 to a body that fails their checks, with the reason in message. Otherwise, something went wrong on our side.
502	Buildertrend didn't return a file. Try again shortly.

Every error, by endpoint

List records

Status	Error	When
400	Invalid request	A filter, sort, limit or skip can't be read. The message names the parameter and what was expected.
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.
403	Forbidden	Your access on the account doesn't include this dataset.
404	Failed to list dataset records	No dataset on your account has this id.
500	Failed to list dataset records	The id isn't a valid dataset id.

Download a file

Status	Error	When
404	Not found	The link has expired, was revoked or was never valid, or the file is no longer on the record.
502	Upstream error	Buildertrend didn't return the file. Try again shortly.

Create a project

Status	Error	When
500	Failed to create project	The body is missing projectName or customerName, or a field is in the wrong format. The message says which.
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.

Get a project

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.

Update a project

Status	Error	When
500	Failed to update project	The body has no projectId (or projectNameIdentifier), or a field is in the wrong format. The message says which.
429	Updating Projects through projectNameIdentifier is not available on your account plan…	projectNameIdentifier was sent on Standard.
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.

Convert an estimate to an invoice

Status	Error	When
401	Bad input	The body is missing txnId, combines options that can't go together, or has a field in the wrong format. The message says which.
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	Operation not allowed	Estimates isn't on your QuickBooks connector.
403	Daily cap exceeded	The account has used its runs for the day: 100 on Standard, 500 on Velocity. They reset at midnight UTC.

Activate a customer

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.
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	Insufficient credits	The account has no credits left for this action.
500	Failed to create project	The run couldn't be started. (The error text is shared with Create a project.)

List runs

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.
500	Failed to list events	The runs couldn't be read. Try again.

Get a run

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.

Get your account

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.
401	No account found	The account behind the key no longer exists.