Datasets · Buildertrend

Buildertrend Internal Users Dataset

Your Buildertrend staff with their role, email, phone and login status.

Record type buildertrend:internalUsers

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

{
  "userId": "6120401",
  "builderId": "48213",
  "name": "Erik Halvorsen",
  "nameNormalized": "erik halvorsen",
  "role": "Owner",
  "email": "erik@halvorsenstyke.example",
  "emails": [
    "erik@halvorsenstyke.example"
  ],
  "primaryEmail": "erik@halvorsenstyke.example",
  "phoneNumber": "(303) 555-0141",
  "hasCompanySettingsAccess": true,
  "autoAccess": false,
  "activationStatus": 3,
  "activationStatusText": "Active",
  "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.

userIdstring
Buildertrend's id for the user.
loginIdstring
Buildertrend's login id for the user. It has matched userId on every user seen so far, but Buildertrend sends it separately.
builderIdstring
Buildertrend's id for the builder account the user belongs to.
namestring
The user's name exactly as Buildertrend shows it, spacing included. Use it to match assignedUser in the Buildertrend Lead Activities Dataset.
nameNormalizedstring
The name lowercased, trimmed and with runs of spaces collapsed to one, for a match that survives a stray double space.
rolestring
The user's role, as the builder named it in Buildertrend, for example Job Superintendent.
roleIdstring
Buildertrend's id for the role.
emailstring
The email field as Buildertrend stores it, which can hold several addresses joined by semicolons.
emailsarray of strings
Every address in email, split, trimmed, lowercased and deduplicated, in the order Buildertrend lists them.
primaryEmailstring
The first address in emails, which is the one Buildertrend shows. The address to send to.
phoneNumberstring
The user's phone number as entered in Buildertrend, with no formatting applied.
cellEmailstring
Buildertrend's cell email field for the user, as entered.
contactInfostring
Buildertrend's contact info field for the user, as entered.
hasCompanySettingsAccessboolean
Whether the user has access to Company Settings in Buildertrend.
autoAccessboolean
Whether Buildertrend's Auto Access setting is on for the user.
activationStatusnumber
Buildertrend's login status code: 3 for active and 0 for inactive in the data seen so far. Read activationStatusText for the label.
activationStatusTextstring
Buildertrend's own label for the login status, for example ACTIVE or INACTIVE.
customFieldsany
The account's custom columns for the user, as Buildertrend sends them. Absent when there are none.
isDeletedboolean
True once the user has been removed from Buildertrend. A deactivated user is not deleted: they stay, with activationStatus 0.
deletedAtdate and time
When Clickr saw the user removed.