Datasets · Buildertrend

Buildertrend Selections Dataset

Selections on a job, with the deadline the client owes a decision by, the approved price, the allowance it draws down and who signed it off.

Record type buildertrend:selections

Read it with List records, or the MCP tool list_dataset_records.

Request

curl -G https://api.clickr.cloud/v2/datasets/{datasetId}/records \
  -H "Authorization: Bearer $CLICKR_API_KEY" \
  --data-urlencode "limit=10"

const response = await fetch(`https://api.clickr.cloud/v2/datasets/{datasetId}/records?${new URLSearchParams({
  "limit": "10"
})}`, {
  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/datasets/{datasetId}/records",
    headers={"Authorization": f"Bearer {os.environ['CLICKR_API_KEY']}"},
    params={
        "limit": "10"
    },
)
data = response.json()

Fields

Every field a record can carry. Filter and sort on them by name, as in filter[jobName][contains]=patel. A field without a value can be missing from a record.

selectionIdstring
Buildertrend's id for the selection, unique across the account.
jobIdstring
Buildertrend's id for the selection's job. Joins to the Buildertrend Jobs Dataset.
builderIdstring
Buildertrend's id for the builder, the company account the selection belongs to.
titlestring
The selection's title.
categorystring
The builder's own grouping for the selection, such as Plumbing Fixtures. Free text and often empty.
locationstring
Where in the house the selection applies, such as Bedroom 1. Free text and often empty.
choiceCountnumber
How many options the client can choose between, 0 when there is nothing to pick yet. The options themselves are not in this dataset.
maxSelectednumber
How many choices may be picked, usually 1. Buildertrend sends -999 where the selection is not limited to one.
pricenumber
The approved price for the selection, in the account's currency. 0 until a priced choice is approved, and not the price of each choice.
allowanceIdstring
Buildertrend's id for the allowance the selection draws down, on jobs that budget allowances.
allowanceTitlestring
The title of the allowance the selection draws down.
allowanceTotalnumber
The allowance's budget, in the account's currency.
remainingAllowancenumber
What is left of the allowance, in the account's currency. It describes the whole allowance, not this selection alone.
deadlinestring
When the client owes the decision, as a date and time with no time zone. Absent means no deadline was set, not that it is due today.
statusnumber
Buildertrend's status code for the selection, sent with no label, so it is not a status name (-1, 2 and 3 have been seen). To tell whether it is decided, read approvedBy and selectedDate.
approvedBystring
Who signed the selection off, a client or a staff member. Absent until someone does.
selectedDatestring
When the selection was signed off, as a date and time with no time zone.
subPriceOutstandingCountnumber
How many of the selection's choices are still waiting on a price from a sub.
tbdPriceCountnumber
How many of the selection's choices are priced TBD.
isLockedboolean
True when the selection is locked and the client can no longer edit it.
attachedFileCountnumber
How many files are attached to the selection.
commentCountnumber
How many comments the selection's discussion has.
isDeletedboolean
True once the selection has been removed in Buildertrend, confirmed by a second read of its job. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the selection removed.