Datasets · Buildertrend

Buildertrend Client Contacts Dataset

Your Buildertrend contacts with their email, phone, address and how many jobs and leads each one is on.

Record type buildertrend:clientContacts

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.

contactIdstring
Buildertrend's id for the contact.
builderIdstring
Buildertrend's id for the builder account the contact belongs to.
displayNamestring
The contact's name exactly as Buildertrend shows it, including any leading, trailing or doubled spaces. Often the only name a contact has.
displayNameNormalizedstring
The display name trimmed, lowercased and with runs of spaces collapsed to one, for matching names. Clickr derives it from displayName.
firstNamestring
The contact's first name, present only when it was entered separately from the display name.
lastNamestring
The contact's last name, present only when it was entered separately from the display name.
emailstring
The contact's email field as Buildertrend stores it, which can hold several addresses separated by semicolons.
emailsarray of strings
Every address in the email field, trimmed, lowercased and with duplicates removed, in the order Buildertrend lists them.
primaryEmailstring
The first address in emails, which is the one Buildertrend shows. Use it when you need a single address to send to.
phonestring
The contact's phone number, as entered. Formats vary from contact to contact, since Buildertrend does not normalise them.
cellstring
The contact's mobile number, as entered, in whatever format it was typed.
streetstring
The street line of the contact's mailing address.
suburbstring
Buildertrend's locality line for non-US addresses. Absent on US addresses.
citystring
The city of the contact's mailing address.
statestring
The state of the contact's mailing address.
zipstring
The ZIP or postal code of the contact's mailing address.
activationStatusnumber
Buildertrend's code for the contact's owner portal login state. 0 is the not invited or inactive end of the scale; other values are not mapped to labels.
activationConfirmeddate and time
When the contact accepted their owner portal invite.
jobCountnumber
The number of jobs Buildertrend shows against the contact on its Contacts page. Can be lower than jobTotalCount.
jobTotalCountnumber
How many jobs the contact is linked to, open or not.
leadCountnumber
The number of leads Buildertrend shows against the contact on its Contacts page. Can be lower than leadTotalCount.
leadTotalCountnumber
How many leads the contact is linked to, open or not.
customFieldsany
Your account's custom contact fields, passed through as Buildertrend sends them. Absent when the contact has none.
isDeletedboolean
True once the contact has been removed from Buildertrend. Clickr keeps the record so you can see it went, and a deactivated contact is not counted as removed.
deletedAtdate and time
When Clickr saw the contact removed.