Datasets · Buildertrend

Buildertrend Leads Dataset

Lead opportunities with their contact, salesperson, status and estimated revenue.

Record type buildertrend:leads

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.

leadIdstring
Buildertrend's id for the lead. Lead activities and lead proposals carry the same id as their leadId.
builderIdstring
Buildertrend's id for the builder account the lead belongs to.
opportunityTitlestring
The lead opportunity's title, with leading and trailing spaces removed.
leadStatusstring
The lead's status in Buildertrend, as a label. Absent when the lead has no status set.
One of Pending, In progress, On hold, Sold, Lost, No opportunity
confidencenumber
Buildertrend's confidence figure for the lead, as the number Buildertrend sends.
proposalStatusCodenumber
Buildertrend's code for the status of the lead's proposal, taken from its most recent status change. Not mapped to labels.
proposalStatusUpdatedAtstring
When the proposal status last changed, as a date and time with no time zone.
proposalStatusUpdatedBystring
The name of the person who made the most recent proposal status change.
salespersonstring
The salesperson assigned to the lead, by name.
sourcestring
Where the lead came from, as recorded in Buildertrend.
projectTypestring
The lead's project type, as set in Buildertrend.
tagsarray of strings
The titles of the tags on the lead.
contactIdstring
Buildertrend's id for the lead's contact.
contactNamestring
The contact's full name. Usually the only name on the lead, since Buildertrend often leaves firstName and lastName blank.
firstNamestring
The contact's first name, when it was entered separately. Often blank even when contactName is set.
lastNamestring
The contact's last name, when it was entered separately. Often blank even when contactName is set.
emailsarray of strings
The contact's email addresses, including any Buildertrend has marked as opted out.
phonestring
The contact's phone number, as entered in Buildertrend.
cellPhonestring
The contact's mobile number, as entered in Buildertrend.
contactStreetstring
The street line of the contact's address.
contactSuburbstring
The suburb line of the contact's address, which Buildertrend uses for non-US addresses.
contactCitystring
The city of the contact's address.
contactStatestring
The state of the contact's address.
contactZipstring
The ZIP or postal code of the contact's address.
opportunityStreetstring
The street line of the address where the work is, which can differ from the contact's address.
opportunitySuburbstring
The suburb line of the address where the work is, which Buildertrend uses for non-US addresses.
opportunityCitystring
The city of the address where the work is.
opportunityStatestring
The state of the address where the work is.
opportunityZipstring
The ZIP or postal code of the address where the work is.
estimatedRevenueMinnumber
The low end of the lead's estimated revenue. Buildertrend sets both ends to the same figure when a single amount was entered.
estimatedRevenueMaxnumber
The high end of the lead's estimated revenue. Equal to estimatedRevenueMin when a single amount was entered.
createdDatestring
When the lead was created in Buildertrend, as a date and time with no time zone.
projectedSalesDatestring
When the lead is projected to sell, as a date and time with no time zone.
soldDatestring
When the lead was sold, as a date and time with no time zone.
proposalLastViewedstring
When the lead's proposal was last viewed, as a date and time with no time zone.
mostRecentClickstring
When Buildertrend last recorded a link click on the lead, as a date and time with no time zone.
hasBeenContactedboolean
Whether Buildertrend marks the lead as contacted.
lastContactedDatestring
When the lead was last contacted, as a date and time with no time zone.
lastContactedBystring
The name of the person who last contacted the lead.
lastContactedActivityTypestring
The type of activity used for the last contact, as Buildertrend names it.
nextActivityDatestring
When the lead's next activity is scheduled, as a date and time with no time zone.
nextActivityTitlestring
The category of the lead's next scheduled activity, as Buildertrend names it.
nextActivityAssigneestring
The name of the person assigned to the lead's next activity.
notesstring
The lead's notes, as plain text.
attachedFileCountnumber
How many files are attached to the lead.
linksClickednumber
How many links Buildertrend counts as clicked on the lead.
relatedJobIdstring
Buildertrend's id for the job the lead converted into, absent until it converts. Joins to the Buildertrend Jobs Dataset.
relatedJobNamestring
The name of the job the lead converted into. Absent until it converts.
isDeletedboolean
True once Buildertrend confirms the lead no longer exists. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the lead removed.
presenceCheckedAtdate and time
When Clickr last confirmed with Buildertrend that the lead still exists while it sits outside the synced lead list. Cleared when the lead reappears there.