Datasets · Buildertrend

Buildertrend Bid Packages Dataset

Scopes of work put out to tender, each with the subs invited, what they quoted and which bid was accepted.

Record type buildertrend:bidPackages

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.

bidPackageIdstring
Buildertrend's id for the bid package.
bidPackageExternalIdstring
The GUID Buildertrend also uses for the package on its newer screens.
jobIdstring
Buildertrend's id for the job the package belongs to. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The name of the job the package belongs to.
builderIdstring
Buildertrend's id for the builder account.
titlestring
The bid package's title.
completionStatusnumber
Buildertrend's own bid package status code, sent with no label. Read releasedDate for whether it went out and approvedCount for whether a bid was accepted.
releasedDatestring
When the package was released to subs. Absent while it is still being prepared.
deadlineDatestring
When bids are due, as a date and time with no time zone. Absent when no deadline is set.
bidRequestCountnumber
How many subs were asked to bid on the package.
responseCountnumber
How many of the invited subs have answered.
approvedCountnumber
How many bids on the package have been accepted.
totalApprovedBidAmountnumber
The total of the accepted bids, not of every bid received.
isUsingDivisionsboolean
Whether the package is split into divisions, which divide it by trade.
bidDivisionCountnumber
How many divisions the package is split into.
unlinkedBidLineItemCountnumber
Buildertrend's count of unlinked bid line items on the package.
relatedScheduleCountnumber
How many schedule items Buildertrend links to the package.
rfiCountnumber
How many requests for information (RFIs) are on the package.
attachedFileCountnumber
How many files are attached to the package.
bidsarray of objects
The subs' bids on this package, sorted by bidId. A bid arriving, changing or being withdrawn is a change to the package, never a created or deleted record.

bids.bidIdstring
Buildertrend's id for the bid, unique across the account.
bids.subNamestring
The sub or vendor the bid is from.
bids.amountnumber
What the sub quoted. 0 until they answer.
bids.submittedStatusnumber
Buildertrend's own code for the bid's submission, sent with no label. submittedDate shows whether it has been submitted.
bids.submittedDatestring
When the bid was submitted. Absent until it has been.
bids.submittedByUserstring
The name of who submitted the bid.
bids.confirmedStatusnumber
Buildertrend's own confirmation code for the bid, sent with no label. confirmedDate shows whether it has been confirmed.
bids.confirmedDatestring
When the bid was confirmed. Absent until it has been.
bids.subViewedDatestring
When the sub opened the bid request. Absent means they have not opened it, not that it was never sent.
bids.isSubmittedByBuilderboolean
True when the builder entered the bid on the sub's behalf rather than the sub submitting it.
bids.isBudgetedboolean
Whether Buildertrend marks the bid as budgeted.
bids.relatedPurchaseOrderIdsarray of strings
Ids of the purchase orders linked to this bid once it is accepted. Joins to the Buildertrend Purchase Orders Dataset.
bids.relatedChangeOrderIdsarray of strings
Ids of the change orders linked to this bid once it is accepted. Joins to the Buildertrend Change Orders Dataset.
bids.attachedFileCountnumber
How many files are attached to the bid.
bids.commentCountnumber
How many comments the bid has.
isDeletedboolean
True once the package has been removed in Buildertrend. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the package removed.