Datasets · Buildertrend

Buildertrend Lead Proposals Dataset

Proposals sent to leads, with the client price, the deposit required, who owns the opportunity and when the status last moved.

Record type buildertrend:leadProposals

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.

leadProposalIdstring
Buildertrend's id for the lead proposal.
leadIdstring
Buildertrend's id for the lead the proposal belongs to. Joins to the Buildertrend Leads Dataset.
builderIdstring
Buildertrend's id for the builder account.
titlestring
The proposal's title.
opportunityTitlestring
The title of the lead the proposal belongs to, copied from the lead.
clientContactNamestring
The name of the client contact being quoted.
clientContactIdstring
Buildertrend's id for the client contact being quoted. Joins to contactId in the Buildertrend Client Contacts Dataset.
clientPricenumber
The price the proposal quotes to the client.
requiredPaymentnumber
The deposit the proposal asks for, not what the client has paid.
proposalStatusnumber
Buildertrend's own proposal status code. Buildertrend sends no label with it, and Clickr does not map it to one.
statusUpdatedDatestring
When the proposal's status last changed, as a date and time with no time zone.
statusUpdatedBystring
The name of who last changed the proposal's status.
paymentStatusnumber
Buildertrend's own code for the deposit on this proposal, sent with no label. It says nothing about the amount: requiredPayment is what the proposal asks for.
isJobProposalboolean
Buildertrend's flag for a proposal that belongs to a job rather than a lead. It has been false on every proposal this dataset has held.
opportunityStatusnumber
The lead's status as Buildertrend's own code, not the proposal's. Join leadId to the Buildertrend Leads Dataset for the rest of the lead.
salespeoplearray of strings
The names of the salespeople on the proposal. Empty when nobody owns it.
projectTypestring
The project type Buildertrend shows for the proposal.
takeoffStatusboolean
Whether a takeoff has been done for this proposal.
lastViewedDatestring
When the client last opened the proposal. Absent means they have not opened it, not that it was never sent.
updatedDatestring
When the proposal was last updated.
createdDatestring
When the proposal was created.
createdBystring
The name of who created the proposal.
isDeletedboolean
True once the proposal is no longer among Buildertrend's lead proposals. A lead converted to a job looks the same, so it can mean converted, not deleted.
deletedAtdate and time
When Clickr saw the proposal leave Buildertrend's lead proposals.