Skip to main content

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"

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.

  • messageKeystring

    The record's key: the folder and Buildertrend's message id, as inbox:12345 or sent:12345. A message in both folders is two records.

  • messageIdstring

    Buildertrend's id for the message.

  • folderstring

    Which folder of the connected login's Messages the record is from: inbox or sent.

    One of inbox, sent

  • builderIdstring

    Buildertrend's id for the builder account the message belongs to.

  • jobIdstring

    Buildertrend's id for the job the message is filed against.

  • jobNamestring

    The name of the job the message is filed against.

  • fromstring

    Who sent the message: their name, or their email address when Buildertrend has no name for them.

  • subjectstring

    The message's subject line.

  • bodyPreviewstring

    The 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.

  • recipientsstring

    Who 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.

  • attachedFileCountnumber

    How many files are attached to the message.

  • sentDatestring

    When the message was sent, in the account's local time, with no time zone.

  • lastModifiedDatestring

    When the message last changed, in the account's local time, with no time zone.

  • lastResponseDatestring

    When someone last replied to the message, in the account's local time. Absent when nobody has.

  • isReplyboolean

    Whether the message is a reply to an earlier one.

  • isForwardedboolean

    Whether the message was forwarded on.

  • isReadboolean

    Whether 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.

  • bodystring

    The whole message as plain text, converted from the HTML Buildertrend stores. Absent until Clickr has read the message whole (see detailSyncedAt).

  • bodyHtmlstring

    The whole message as Buildertrend stores it, in HTML. Absent until Clickr has read the message whole.

  • toarray of objects

    Who 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.namestring

    The person's name, as Buildertrend shows it on the message.

  • to.userIdstring

    Buildertrend's id for the person.

  • to.isExternalboolean

    Whether the person is outside the builder's Buildertrend account.

  • ccarray of objects

    Who was copied on the message, in the same shape as to.

  • cc.namestring

    The person's name, as Buildertrend shows it on the message.

  • cc.userIdstring

    Buildertrend's id for the person.

  • cc.isExternalboolean

    Whether the person is outside the builder's Buildertrend account.

  • bccarray of objects

    Who was blind copied, in the same shape as to. Buildertrend shows these only to the sender, so they appear on Sent messages.

  • bcc.namestring

    The person's name, as Buildertrend shows it on the message.

  • bcc.userIdstring

    Buildertrend's id for the person.

  • bcc.isExternalboolean

    Whether the person is outside the builder's Buildertrend account.

  • fromEmailstring

    The sender's email address.

  • isFromExternalboolean

    Whether the sender is outside the builder's Buildertrend account.

  • inReplyToMessageIdstring

    The messageId of the message this one replies to. Absent when it starts a conversation.

  • filesarray of objects

    The files attached to the message, one entry per file, sorted by fileId. Empty until Clickr has read the message whole.

  • files.fileIdstring

    Buildertrend's id for the file.

  • files.titlestring

    The file's name as uploaded, extension included.

  • files.extensionstring

    The file's extension.

  • files.isPhotoboolean

    Whether the file is a photo.

  • files.sizeInBytesnumber

    The file's size in bytes.

  • files.addedBystring

    Who uploaded the file.

  • files.dateAttachedstring

    When the file was attached, in the account's local time.

  • files.jobIdstring

    Buildertrend's id for the job the file belongs to.

  • files.downloadUrlstring

    A 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 time

    When 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.

  • isDeletedboolean

    True once the message has left its folder. Buildertrend does not say whether it was deleted or moved, so this covers both.

  • deletedAtdate and time

    When Clickr found the message had left its folder.