Datasets · Buildertrend

Buildertrend Documents Dataset

Every file your team keeps in a job's Documents folders, with the folder it is in and a link to download it. Read once a day.

Record type buildertrend:documents

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.

documentKeystring
The record's key, the job and the file as {jobId}:file:{fileId}. Moving the file to another folder keeps the same key.
jobIdstring
Buildertrend's id for the job whose Documents hold the file. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The job's name in Buildertrend. A rename alone is not reported as a change to the file.
builderIdstring
Buildertrend's id for the builder account.
fileIdstring
Buildertrend's id for the file. The downloadUrl on this record is a link to the same file.
documentIdstring
Buildertrend's other id for the file. It does not address the file, so use fileId.
titlestring
The file's name as uploaded, extension included.
extensionstring
The file's extension, such as pdf.
sizeInBytesnumber
The file's size in bytes.
addedBystring
The name of the person who added the file.
dateAttachedstring
When the file was added in Buildertrend.
dateModifiedstring
When the file was last modified in Buildertrend.
isTemplateboolean
Whether Buildertrend marks the file as a template.
folderIdstring
Buildertrend's id for the folder the file is in. A file moved to another folder keeps its record and changes this.
folderPathstring
Where the file sits, read like Buildertrend's own breadcrumb (Documents / Plans). Renaming a folder updates it without reporting its files as changed.
showSubsboolean
Buildertrend's setting for whether subcontractors may see the file. Accounts that never use it have it false everywhere, so false does not always mean hidden.
showOwnerboolean
Buildertrend's setting for whether the client may see the file.
rowVersionstring
Buildertrend's version marker for the file's link. A change to it alone is not reported as a change to the file.
ownerViewedDatestring
When the client viewed the file in Buildertrend. A change to it alone is not reported as a change to the file.
isDeletedboolean
True once the file has been removed from the job's Documents in Buildertrend. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the file removed. Documents are read about once a day, on open jobs only.
downloadUrlstring
A signed link to the file that needs no API key. It is minted on every read and expires after 1 hour, so read the record again rather than storing it.