Datasets · Buildertrend

Buildertrend Jobs Dataset

Every job with its status, address and projected start and completion.

Record type buildertrend:jobs

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()

Record

Example record

{
  "jobId": "7310421",
  "builderId": "48213",
  "jobName": "Henderson Residence Addition",
  "jobStatus": "Open",
  "jobType": "Addition",
  "street": "2147 Aspenleaf Ct",
  "city": "Boulder",
  "state": "CO",
  "zip": "80304",
  "contacts": [
    {
      "id": "8800101",
      "name": "Dana Henderson",
      "phone": "(303) 555-0161",
      "email": "dana.henderson@example.com",
      "street": "2147 Aspenleaf Ct",
      "city": "Boulder",
      "state": "CO",
      "zip": "80304"
    }
  ],
  "projectManager": [
    "Jordan Pike"
  ],
  "projectedStart": "2026-08-06T00:00:00",
  "projectedCompletion": "2027-01-03T00:00:00",
  "actualStart": "2026-08-06T00:00:00",
  "isScheduleOnline": true,
  "isDeleted": false
}

From the sample builder, Halvorsen & Styke.

Ask Claude or ChatGPT about the same records: add https://api.clickr.cloud/mcp/playground as a connector, with no sign-in. Try it on a sample builder ›

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.

jobIdstring
Buildertrend's id for the job. Other Buildertrend datasets carry it as jobId, so it is the key to join them on.
builderIdstring
Buildertrend's id for the builder, the company account the job belongs to.
jobNamestring
The job's name in Buildertrend.
jobStatusstring
The job's status, named as Buildertrend's own status list names it. Use this rather than status, which is a different code.
One of Presale, Open, Warranty, Closed
jobColorHexstring
The colour assigned to the job in Buildertrend, as a hex code.
jobPrefixstring
The job's prefix, as set on the job in Buildertrend.
statusnumber
A second, unlabelled status code from Buildertrend's Jobs list. It is not the same code as jobStatus, so read jobStatus for the job's status.
jobTypestring
The job's type, as Buildertrend's Jobs list shows it. detail.jobType carries it with its id.
contractTypestring
The job's contract type, such as Fixed Price or Open Book.
groupsarray of strings
The names of the job groups the job is in.
workTemplatestring
The work template Buildertrend's Jobs list shows for the job.
lotstring
The lot recorded on the job in Buildertrend.
permitstring
The permit recorded on the job in Buildertrend.
streetstring
The job site's street address.
citystring
The job site's city.
statestring
The job site's state.
zipstring
The job site's zip code.
suburbstring
The job site's suburb. Buildertrend uses it for Australian addresses.
mappingDataany
Buildertrend's map data for the job site as it sends it, with the geocoding status and the coordinates.
latitudenumber
The job site's latitude, from Buildertrend's map data.
longitudenumber
The job site's longitude, from Buildertrend's map data.
contactsarray of objects
The job's clients, one entry per client with their contact details.

contacts.idstring
Buildertrend's id for the client contact.
contacts.namestring
The client's name.
contacts.phonestring
The client's phone number, as entered in Buildertrend.
contacts.emailstring
The client's email address.
contacts.streetstring
The client's street address.
contacts.citystring
The client's city.
contacts.statestring
The client's state.
contacts.zipstring
The client's zip code.
contacts.suburbstring
The client's suburb. Buildertrend uses it for Australian addresses.
projectManagerarray of strings
The names of the job's project managers.
createdByany
Who created the job, as Buildertrend sends it.
statusLastUpdatedBystring
The name of whoever last changed the job's status.
createdDateany
When the job was created, as Buildertrend sends it.
projectedStartany
The job's projected start date, as Buildertrend sends it.
projectedCompletionany
The job's projected completion date, as Buildertrend sends it.
actualStartany
The job's actual start date, as Buildertrend sends it.
actualCompletionany
The job's actual completion date, as Buildertrend sends it.
statusLastUpdatedDateany
When the job's status last changed, as Buildertrend sends it.
warrantyany
The job's warranty value from Buildertrend's Jobs list, as sent.
contractPriceany
The job's contract price, as Buildertrend's Jobs list sends it. detail.contractPrice has it as a plain number.
approvedCOPriceany
The total of the job's approved change orders, as Buildertrend sends it.
jobRunningTotalany
The job's running total, as Buildertrend sends it.
paymentsReceivedany
The payments received on the job, as Buildertrend sends them.
ownerBalanceany
The balance the client still owes on the job, as Buildertrend sends it.
appliedCreditMemosany
The credit memos applied to the job, as Buildertrend sends them.
allowanceDifferenceany
The job's allowance difference, as Buildertrend sends it.
totalCostany
The job's total cost, as Buildertrend sends it.
costsPaidany
The job's costs paid so far, as Buildertrend sends them.
costsOutstandingany
The job's costs still outstanding, as Buildertrend sends them.
grossProfitany
The job's gross profit, as Buildertrend sends it.
originalBudgetCostsany
The job's original budgeted costs, as Buildertrend sends them.
revisedBudgetCostsany
The job's revised budgeted costs, as Buildertrend sends them.
amountInvoicedany
The amount invoiced on the job, as Buildertrend sends it.
projectedCostsany
The job's projected costs, as Buildertrend sends them.
projectedProfitany
The job's projected profit, as Buildertrend sends it.
individualPOLimitany
The limit on a single purchase order for the job, as Buildertrend's Jobs list sends it. detail.individualPOLimit has it as a plain number.
overallPOLimitany
The limit on the job's purchase orders overall, as Buildertrend sends it.
costRateany
The job's cost rate, as Buildertrend's object holding a cost and a unit.
priceRateany
The job's price rate, as Buildertrend's object holding a cost and a unit.
totalAreaany
The job's total area, as Buildertrend's object holding a value and a unit. detail.totalArea has the number alone.
creditCardTransactionLimitany
Whether the job takes online card payments, with the minimum and maximum amounts, as Buildertrend's object.
achTransactionLimitany
Whether the job takes online ACH bank payments, with the minimum and maximum amounts, as Buildertrend's object.
accountingStatusnumber
Buildertrend's unlabelled code for the job's accounting link. detail.accounting says whether the job is linked and whether a sync is queued.
isScheduleOnlineboolean
Whether the job's schedule is set online in Buildertrend.
takeoffStatusboolean
Buildertrend's takeoff flag for the job.
ownerActivationStatusnumber
Buildertrend's code for the client's portal activation on the job. Its labels have not been confirmed.
customFieldsany
The job's custom field values from Buildertrend's Jobs list, as sent. detail.customFields carries each one with its title and type.
subNotesstring
The job's notes for subs, which subcontractors can see.
lastSeenScopestring
Which read last confirmed the job: allJobs, a read of every job, or openJobs, the routine read of open jobs only.
One of allJobs, openJobs
lastSeenAtdate and time
When Clickr last saw the job in a read from Buildertrend.
detailobject
Fields only the job's own record in Buildertrend carries, fetched one job at a time. Absent until fetched, which is normal for a closed job.
detail.jobStatusobject
The job's status, with its Buildertrend code.

detail.jobStatus.idnumber
Buildertrend's status code: 0 Closed, 1 Open, 3 Presale, 4 Warranty.
detail.jobStatus.namestring
The status's name, such as Open.
detail.jobTypeobject
The job's type, with its Buildertrend id.
detail.jobType.idnumber
Buildertrend's id for the job type.
detail.jobType.namestring
The job type's name.
detail.contractTypeobject
The job's contract type, with its Buildertrend id.
detail.contractType.idnumber
Buildertrend's id for the contract type.
detail.contractType.namestring
The contract type's name, such as Fixed Price or Open Book.
detail.jobGroupsarray of objects
The job groups the job is in, with their ids.
detail.jobGroups.idnumber
Buildertrend's id for the job group.
detail.jobGroups.namestring
The job group's name.
detail.jobColorobject
The colour assigned to the job.
detail.jobColor.idnumber
Buildertrend's id for the colour.
detail.jobColor.namestring
The colour's name in Buildertrend's palette.
detail.jobColor.hexstring
The colour as a hex code, such as #FF9600.
detail.projectManagersarray of objects
The job's project managers, with their ids.
detail.projectManagers.idnumber
Buildertrend's user id for the project manager.
detail.projectManagers.namestring
The project manager's name.
detail.internalNotesstring
Notes on the job for the builder's own staff only. Subs do not see them.
detail.jobsitePrefixstring
The job's prefix, from the job's own record in Buildertrend.
detail.dateOpenedstring
When the job was opened, as a date and time with no time zone.
detail.openedByobject
Who opened the job.
detail.openedBy.idnumber
Buildertrend's user id for the person who opened the job.
detail.openedBy.namestring
The name of the person who opened the job.
detail.scheduleStartstring
The start of the job's schedule, which Buildertrend works out from its schedule items. Absent when the job has none.
detail.scheduleEndstring
The end of the job's schedule, which Buildertrend works out from its schedule items. Absent when the job has none.
detail.hasScheduleItemsboolean
Whether the job has any schedule items.
detail.syncActualStartEndboolean
Buildertrend's setting for syncing the job's actual start and end, as sent.
detail.workDaysarray of strings
The days of the week the job works, such as Monday, in Buildertrend's order with Sunday first.
detail.mappingStatusnumber
Buildertrend's geocoding status code for the job site.
detail.pinTypenumber
Buildertrend's map pin type code for the job site.
detail.enableGeofencingboolean
Whether geofencing is turned on for the job.
detail.includeTimeClockForCostsboolean
Whether time clock entries count towards the job's costs.
detail.includeTimeClockForBudgetboolean
Whether time clock entries count towards the job's budget.
detail.includeAllowancesboolean
Whether the job includes allowances.
detail.updateRunningTotalForSelectionboolean
Whether selections update the job's running total.
detail.notifyProjectManagerboolean
Whether the job's notify project manager setting is on.
detail.isTemplateboolean
Whether the job is saved as a template.
detail.templateNamestring
The template name Buildertrend holds on the job.
detail.contractPricenumber
The job's contract price as a plain number, in the account's currency.
detail.individualPOLimitnumber
The most a single purchase order on the job may be for, in the account's currency. Absent when no limit is set.
detail.totalPOLimitnumber
The total purchase order limit for the job, in the account's currency. Absent when no limit is set.
detail.totalAreanumber
The job's total area as a plain number, in the unit the account uses, such as square feet.
detail.defaultTaxGroupIdnumber
Buildertrend's id for the job's default tax group.
detail.customFieldsarray of objects
The job's custom fields, each with its title, type and value.
detail.customFields.idnumber
Buildertrend's id for the custom field.
detail.customFields.titlestring
The custom field's name.
detail.customFields.typestring
The custom field's type, such as MultiLineText.
detail.customFields.valueany
The custom field's value on this job, as Buildertrend sends it.
detail.customFields.onOwnerPortalboolean
Whether the custom field is shown on the client portal.
detail.financialSettingsany
The job's financial settings as Buildertrend sends them: markup and margin defaults, draw schedule, tax version and budget display preferences.
detail.leadobject
The lead the job was converted from. Absent when the job did not come from a lead.
detail.lead.leadIdnumber
Buildertrend's id for that lead. Joins to the Buildertrend Leads Dataset, where it is a string.
detail.lead.leadTitlestring
The lead's title.
detail.lead.leadStatusnumber
Buildertrend's status code for the lead.
detail.lead.leadAddedByUserstring
The name of the user who added the lead.
detail.lead.leadAddedByDatestring
When the lead was added, as a date and time with no time zone.
detail.accountingobject
The job's link to the accounting system connected to Buildertrend.
detail.accounting.linkedToAccountingboolean
Whether the job is linked to the accounting system.
detail.accounting.inPendingSyncboolean
Whether a sync to the accounting system is queued for the job.
detail.accounting.integrationTypenumber
Buildertrend's code for which accounting system the job is linked to.
detail.accounting.messagestring
Buildertrend's accounting message for the job, when it has one.
detail.ownerInfoany
The job's client portal settings as Buildertrend sends them: what the client can see and pay.
detailSyncedAtdate and time
When Clickr last fetched the job's detail.
isDeletedboolean
True once the job has been removed in Buildertrend, checked against a read of every job so a job that only closed is not marked. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the job removed.