Datasets ยท Buildertrend
Buildertrend Messages Dataset
Emails in the Inbox and Sent folders of the Buildertrend login Clickr connects with, with each one's job, sender, recipients, subject, the whole message and its attachments.
- Record type
buildertrend:messages - 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.
messageKeystringThe record's key: the folder and Buildertrend's message id, as inbox:12345 or sent:12345. A message in both folders is two records.
messageIdstringBuildertrend's id for the message.
folderstringWhich folder of the connected login's Messages the record is from: inbox or sent.
One of
inbox,sentbuilderIdstringBuildertrend's id for the builder account the message belongs to.
jobIdstringBuildertrend's id for the job the message is filed against.
jobNamestringThe name of the job the message is filed against.
fromstringWho sent the message: their name, or their email address when Buildertrend has no name for them.
subjectstringThe message's subject line.
bodyPreviewstringThe first 500 characters of the message, as Buildertrend's Messages page shows them. A longer message is cut off here with no marker, so this is not the whole message: that is body.
recipientsstringWho the message went to, as Buildertrend's grid lists them. Absent on Inbox messages, where the grid sends none; to, cc and bcc list the recipients on both folders.
attachedFileCountnumberHow many files are attached to the message.
sentDatestringWhen the message was sent, in the account's local time, with no time zone.
lastModifiedDatestringWhen the message last changed, in the account's local time, with no time zone.
lastResponseDatestringWhen someone last replied to the message, in the account's local time. Absent when nobody has.
isReplybooleanWhether the message is a reply to an earlier one.
isForwardedbooleanWhether the message was forwarded on.
isReadbooleanWhether the connected Buildertrend login has opened the message. It is that login's own read state, so a change to it is never reported as an update.
bodystringThe whole message as plain text, converted from the HTML Buildertrend stores. Absent until Clickr has read the message whole (see detailSyncedAt).
bodyHtmlstringThe whole message as Buildertrend stores it, in HTML. Absent until Clickr has read the message whole.
toarray of objectsWho the message was sent to: each person's name, their Buildertrend user id, and whether they are outside the builder's Buildertrend account. Empty until Clickr has read the message whole.
to.namestringThe person's name, as Buildertrend shows it on the message.
to.userIdstringBuildertrend's id for the person.
to.isExternalbooleanWhether the person is outside the builder's Buildertrend account.
ccarray of objectsWho was copied on the message, in the same shape as to.
cc.namestringThe person's name, as Buildertrend shows it on the message.
cc.userIdstringBuildertrend's id for the person.
cc.isExternalbooleanWhether the person is outside the builder's Buildertrend account.
bccarray of objectsWho was blind copied, in the same shape as to. Buildertrend shows these only to the sender, so they appear on Sent messages.
bcc.namestringThe person's name, as Buildertrend shows it on the message.
bcc.userIdstringBuildertrend's id for the person.
bcc.isExternalbooleanWhether the person is outside the builder's Buildertrend account.
fromEmailstringThe sender's email address.
isFromExternalbooleanWhether the sender is outside the builder's Buildertrend account.
inReplyToMessageIdstringThe messageId of the message this one replies to. Absent when it starts a conversation.
filesarray of objectsThe files attached to the message, one entry per file, sorted by fileId. Empty until Clickr has read the message whole.
files.fileIdstringBuildertrend's id for the file.
files.titlestringThe file's name as uploaded, extension included.
files.extensionstringThe file's extension.
files.isPhotobooleanWhether the file is a photo.
files.sizeInBytesnumberThe file's size in bytes.
files.addedBystringWho uploaded the file.
files.dateAttachedstringWhen the file was attached, in the account's local time.
files.jobIdstringBuildertrend's id for the job the file belongs to.
files.downloadUrlstringA link to download the file that needs no API key. It is made fresh each time the record is read and expires 1 hour later, so read the record again rather than storing it.
detailSyncedAtdate and timeWhen Clickr read the whole message. Clickr does this once per message, newest first, so on a first sync older messages fill in over a few hours. Absent until then, and body, to, cc, bcc and files with it.
isDeletedbooleanTrue once the message has left its folder. Buildertrend does not say whether it was deleted or moved, so this covers both.
deletedAtdate and timeWhen Clickr found the message had left its folder.