An API (application programming interface) is a published way for programs, not people, to ask another system to do something over a network. Think of it as three parts of the same building:

Companies use it to bring data in from ERP systems, pull data out for reporting dashboards, connect field telematics, and automate repeatable tasks. B2W uses the same API internally for native job imports and true-up batches.

What can you do with it?

Anything you can do in the application, for the functional areas the API exposes, within the permissions of whoever signed in. The version 26.1.2.1 catalog lists 63 functional areas and 272 operations (see question 16).

Ops API vs. legacy Web Services

Some integrations still use the older SOAP Web Services. They are a different product, so check which one you are working with first.

The four methods map to the four basic data actions, often called CRUD: Create (POST), Read (GET), Update (PUT), and Delete (DELETE). Here is a complete create call with every part labeled:

POST /OpsAPI_<environment>/Employee HTTP/1.1          # 1 address + 2 method
Host: <cluster>.b2w.trimble.com
Authorization: Bearer <AccessToken>                    # 3 headers
Content-Type: application/json

{                                                      # 4 body
  "EmployeeID": "90001",
  "LastName": "Employee",
  "BusinessUnitUniqueName": "Organization"
}

The response always carries a status code, such as 201 Created or 401 Unauthorized, and plain text shaped as JSON. You will see the same responses in Postman, in Swagger, and in integration logs. Question 20 explains every code.

• The cluster is the server group your environment is hosted on, such as <cluster>.b2w.trimble.com.
• The environment is your site name: the last part of your Ops address.
• Your Ops website is https://{cluster}/{environment}. Your API is the same address with OpsAPI_ added before the environment.
• The path is not case-sensitive. opsapi_<environment> works the same as OpsAPI_<environment>.

Check an environment

Paste your Ops address. The checker builds all three API addresses and sends a sample request to each one to see whether it answers.

Enlarge

Scroll down to API Documentation to see every functional area. Click an area to expand its operations, then click an operation to see its parameters, example values, and response codes.

Enlarge

The same catalog is also available as a machine-readable OpenAPI 3 file at /doc/v2/OpsAPI.json. Postman can import it to generate requests, but the B2W Ops API collection in question 6 already has authentication set up, so start there.

1. Download the appGo to postman.com/downloads and download the version for your computer (Windows, macOS, or Linux).
2. Install itRun the installer. Postman opens when it finishes.
3. Sign inSign in, or create a free account. You need to be signed in to import and save collections.

Download Postman

1. Download the collectionClick Download the Postman collection. The file is B2W-Ops-API.postman_collection.json.
2. Open Import in PostmanClick Import at the top of the sidebar, or press Ctrl+O (⌘+O on a Mac).
3. Add the fileDrag the downloaded file into the Import window, or click to browse for it.
4. ConfirmFinish the import. B2W Ops API appears under Collections.

Download the Postman collection

What’s inside

Every call except /Ping and /Version needs proof of identity. You prove it once, by sending credentials to the login endpoint in HTTP headers, never in the URL or the JSON body. The response gives you an access token to use on every other call.

The order /Login checks headers in

GET /Login looks for one complete pair of credentials, in this order, and uses the first pair it finds:

Username and password details

The userName header must match the Windows account name stored on the Ops user, written as DOMAIN\user or user@domain. Ops checks the format, verifies the password with the Windows domain controller, then confirms the account exists in the Ops user table. The token it issues is tied to that person, so every action is traceable to them.

LoginWithTID

This is a different endpoint, GET /LoginWithTID. Instead of a credential pair, you send a Trimble ID access token that the person got by signing in to Trimble ID. Ops exchanges it for an Ops access token.

1. Open UsersFrom the gear (⚙) menu at the top right of B2W Ops, open Users, then open the person’s record. You land on User View.
2. Check the TID / Mobile E-mail AddressIt must be filled in. This is what links the Ops user to their Trimble ID.
3. Click User API SecretIt sits under the e-mail address, between Show TID ID and Manage TID.
4. Note the security roleCalls made with these credentials can only do what this role allows.

Enlarge

The User API Secret dialog opens:

1. TID IDThis is the tiduuid. Put it in the tidUuid variable in Postman.
2. User API SecretThis is the apiSecret. Put it in the apiSecret variable.
3. Copy to ClipboardCopies the secret, which is masked on screen.
4. Generate User API SecretCreates a secret when the user doesn’t have one. A value must be generated before anyone can call the API as this user.

Enlarge

1. Open Integrations & Add-insFrom the gear (⚙) menu at the top right of B2W Ops, open Integrations & Add-ins.
2. Click Manage API KeyIt is the first button at the top right of the page. The dialog shows the client ID and client secret that B2W Ops generated for this environment.
3. Use them in PostmanPut them in the clientId and clientSecret variables, then send Auth → Login with client ID and secret.

Enlarge

When to use it: scheduled overnight jobs and middleware that shouldn’t depend on one person’s credentials. Two responses are specific to this method:

• 401 The client ID or secret doesn’t match the values stored in Ops system settings.
• 404 The credentials are valid, but the built-in System Administrator record is missing in Ops.

1. Open the collection’s Variables tabIn the sidebar, click B2W Ops API at the very top, then the Variables tab.
2. baseUrlThe Ops API URL with no slash at the end, for example https://<cluster>.b2w.trimble.com/OpsAPI_<environment>.
3. tidUuidThe TID ID from the User API Secret dialog.
4. apiSecretThe User API Secret.
5. accessTokenLeave it. It holds your token after you log in (question 11).

Enlarge

1. Open the Auth folderIn the B2W Ops API collection.
2. Select “Login with TID uuid and API secret”It is a GET request to {{baseUrl}}/Login.
3. Check the headersOn the Headers tab, tiduuid and apiSecret pull their values from your variables.
4. Click SendOr press Ctrl+Enter.
5. Look for 200 OKAny other code means the login failed. See question 21.
6. Find the AccessTokenThat value is your bearer token. Make sure it is in the accessToken variable before you call other endpoints.

Enlarge

The same request outside Postman

$baseUrl = "https://<cluster>.b2w.trimble.com/OpsAPI_<environment>"

# Credentials go in the headers, never in the URL or the body
$login = Invoke-RestMethod -Method Get -Uri "$baseUrl/Login" -Headers @{
    tiduuid   = "<your TID ID>"
    apiSecret = "<your User API Secret>"
}

$token = $login.AccessToken   # this is your bearer token

curl -s 'https://<cluster>.b2w.trimble.com/OpsAPI_<environment>/Login' \
  -H 'tiduuid: <your TID ID>' \
  -H 'apiSecret: <your User API Secret>'

GET /OpsAPI_<environment>/Login HTTP/1.1
Host: <cluster>.b2w.trimble.com
tiduuid: <your TID ID>
apiSecret: <your User API Secret>

A successful login returns 200 OK and a small JSON object:

{
  "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOi…",
  "RefreshToken": "<refresh token>"
}

Token facts

• AccessToken and bearer token mean the same thing. It is a signed JWT.
• A token lasts 1 day by default. The site setting Security:JWT:Lifetime controls this.
• A token also stops working once you generate a new one, so always use your latest.
• When a token expires, data calls return 401 Unauthorized. Log in again for a new one.
• The response also includes a RefreshToken. The catalog has no refresh endpoint, so when your token expires, simply log in again.

Is a token expired, or whose is it? Paste it into the token inspector. It shows when the token was issued and expires, and who it belongs to. It decodes the token on this page only and clears it when you close the window.

Signing in and calling data are separate steps. Your secrets only ever go to the login endpoint; every other call carries the token instead. Here is a first data call that reads five employees:

$headers = @{ Authorization = "Bearer $token" }

# For GET, -Body becomes the query string: /Employee?$top=5
$employees = Invoke-RestMethod -Method Get -Uri "$baseUrl/Employee" -Headers $headers -Body @{ '$top' = 5 }
$employees | Select-Object EmployeeID, FirstName, LastName

curl -s -G 'https://<cluster>.b2w.trimble.com/OpsAPI_<environment>/Employee' \
  --data-urlencode '$top=5' \
  -H 'Authorization: Bearer <AccessToken>'

GET /OpsAPI_<environment>/Employee?$top=5 HTTP/1.1
Host: <cluster>.b2w.trimble.com
Authorization: Bearer <AccessToken>

The response is a JSON array of employee records. This sample comes from the catalog’s own example:

[
  {
    "ObjectID": "a4066d42-4027-4d5d-87a0-a30600f8d4cf",
    "EmployeeID": "12865",
    "FirstName": "Ralph",
    "LastName": "Newman",
    "JobTitle": "Field Employee",
    "IsFieldEmployee": true,
    "IsInactive": false,
    "BusinessUnitUniqueName": "Northern Division\\Paving",
    "RowVersion": 1
  }
]

Reading the result

In the Postman collection, the Ping request uses the pingInput variable, which defaults to hello.

Enlarge

Examples for <environment>

# One employee by ID
{{baseUrl}}/Employee?$filter=EmployeeID eq '12865'

# Just three fields, sorted by last name
{{baseUrl}}/Employee?$select=EmployeeID,FirstName,LastName&$orderby=LastName

# Active jobs, page 2 (records 101-200)
{{baseUrl}}/Job?$filter=IsActive eq true&$orderby=JobNumber&$top=100&$skip=100

Paging through more than 100 records

Keep going until a page comes back with fewer than 100 records. Sort with $orderby so the pages stay in a stable order.

Create a record (POST)

Send the new record as JSON. For an employee, the catalog requires EmployeeID, LastName, and BusinessUnitUniqueName. A success returns 201 Created; a body that isn’t a valid record returns 422.

$body = @{
    EmployeeID             = "90001"
    FirstName              = "Test"
    LastName               = "Employee"
    BusinessUnitUniqueName = "Organization"
    IsFieldEmployee        = $true
} | ConvertTo-Json

Invoke-RestMethod -Method Post -Uri "$baseUrl/Employee" -Headers $headers -Body $body -ContentType "application/json"

curl -s -X POST 'https://<cluster>.b2w.trimble.com/OpsAPI_<environment>/Employee' \
  -H 'Authorization: Bearer <AccessToken>' \
  -H 'Content-Type: application/json' \
  -d '{"EmployeeID":"90001","FirstName":"Test","LastName":"Employee","BusinessUnitUniqueName":"Organization","IsFieldEmployee":true}'

POST /OpsAPI_<environment>/Employee HTTP/1.1
Host: <cluster>.b2w.trimble.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

{
  "EmployeeID": "90001",
  "FirstName": "Test",
  "LastName": "Employee",
  "BusinessUnitUniqueName": "Organization",
  "IsFieldEmployee": true
}

Update a record (PUT)

The catalog’s rule: first GET the record by its key, change the fields you need, then PUT the whole record back. Keep its ObjectID and RowVersion exactly as you received them. A success returns 200 OK.

# 1. GET the current record
$record = Invoke-RestMethod -Uri "$baseUrl/Employee" -Headers $headers -Body @{ '$filter' = "EmployeeID eq '90001'" } | Select-Object -First 1

# 2. Change only what you need
$record.JobTitle = "Field Employee"

# 3. PUT the whole record back, ObjectID and RowVersion included
Invoke-RestMethod -Method Put -Uri "$baseUrl/Employee" -Headers $headers -Body ($record | ConvertTo-Json -Depth 5) -ContentType "application/json"

If a PUT returns 409 Conflict, the update clashes with the record’s current state, for example because someone changed it after you read it. GET it again and reapply your change.

Delete a record (DELETE)

Send the record’s ObjectID as a query parameter or as a header named ObjectID. A success returns 204 No Content.

DELETE /OpsAPI_<environment>/Employee?ObjectID=<ObjectID> HTTP/1.1
Host: <cluster>.b2w.trimble.com
Authorization: Bearer <AccessToken>

Rules to remember

• You cannot change an ObjectID through the API. It is the record’s permanent key.
• Each action needs the matching API permission in the caller’s security role: Create, View, Edit, or Delete (question 21).
• A read-only license cannot make changes, even if the security role would allow them.

Each card’s Build button opens that endpoint in the request builder, which writes a ready-to-run request for Postman, PowerShell, cURL, or raw HTTP.

The list reflects the version 26.1.2.1 catalog, checked October 2, 2026. Environments on other versions may differ, and their own Swagger page is always the source of truth.

1. API surface

   Is it the Ops API (JSON) or the older Web Services (SOAP XML)?

2. Base URL and connectivity

   Is the base URL right, and does GET /Ping/hello succeed? Always check connectivity first.

3. Authentication method

   Which sign-in method does the call use: user (username and password), TID, or client ID and secret?

4. Login response, on its own

   Does the login return a token? Look at the login’s status code and body separately from the data call’s.

5. Header authorization

   Does the data call carry the correct AccessToken in an Authorization: Bearer header?

Gather these details

• Company and environment name
• The Ops API URL being called
• Endpoint and method, such as GET /Job
• The login method
• Status code and response body, with secrets removed
• Date, time, and time zone of the failure
• The tool or integration making the call
• Whether it ever worked, and what changed

The decoder reads the messages the Ops API sends, such as the InternalMessage on a 403 that names the missing privilege, plus errors from Postman, PowerShell, IIS, and the network. Decoding runs entirely in your browser. Still, take tokens and secrets out of anything you copy into an email or support case.

Prefer to read it all at once? Every cause and fix the troubleshooter can reach is also listed in question 21.

403 Forbidden: “insufficient privileges”

A 403 almost always means the user’s Ops security role doesn’t grant the API permission the call needs. The response names the missing privilege:

Enlarge

1. Open the user’s security role in OpsFrom their User View (Figure 3), click the role name.
2. Find the API section and the area’s rowCheck the column for the action: View for GET, Create for POST, Edit for PUT, Delete for DELETE. A filled green dot means granted.

Enlarge

Every other common error

Answers to the questions people ask most.

Everything on one screen. It prints on a single page if you print this section alone.

AccessToken / bearer token

The signed token the login returns. Sent on every data call as Authorization: Bearer …. Lasts 1 day by default.

API

Application programming interface: a published way for programs to request actions from another system.

apiSecret / User API Secret

A per-user secret generated in Ops. Paired with the TID ID to log in as that user.

Base URL

The root address of an environment’s API, such as https://<cluster>.b2w.trimble.com/OpsAPI_<environment>.

Client ID / client secret

Environment-level credentials from Manage API Key. They log in as the built-in System Administrator.

Cluster

The server group that hosts an environment, such as <cluster>.b2w.trimble.com.

CRUD

Create, Read, Update, Delete: the four basic data actions, matching POST, GET, PUT, and DELETE.

Endpoint

One address and method the API answers, such as GET /Employee.

Environment

A site name: the last part of the Ops address.

Functional area

A group of related endpoints in the catalog, such as Employee or Job.

Header

A key-value pair sent with a request, such as Content-Type: application/json.

JSON

The plain-text data format the Ops API sends and receives.

JWT

JSON Web Token: the signed format of the AccessToken.

LoginWithTID

The endpoint that exchanges a Trimble ID token for an Ops access token.

ObjectID

A record’s permanent unique key (a GUID). Used to target updates and deletes. It can’t be changed.

OData

The query standard behind $filter, $select, $orderby, $top, and $skip.

Page size

The most records one GET returns: 100 by default.

Postman collection

A shared, ready-made set of requests and variables, imported into Postman.

REST

The API style the Ops API uses: one URL per resource, standard HTTP methods, JSON data.

RowVersion

A number on each record that changes when it is saved. Send it back unchanged on a PUT.

Security role

The Ops role whose API section grants Create, View, Edit, and Delete per area.

SOAP / Web Services

The older B2W API: .asmx URLs, POST-only, XML envelopes.

Status code

The three-digit result of a call, such as 200, 401, or 403.

Swagger

The interactive catalog at /doc/index.html that lists every endpoint and field.

TID (Trimble ID)

Trimble’s identity service. In TID mode, users sign in to Ops with their Trimble ID.

tiduuid / TID ID

The unique ID of a user’s Trimble identity, shown in the User API Secret dialog.

The Estimate API v1 catalog lists 56 functional areas and 227 operations. It supports GET, POST, and PUT. There is no DELETE.

How it differs from the Ops API

The path is not case-sensitive, so estapi_<environment> works too.

Check an environment

Enlarge

The machine-readable catalog is at /doc/v1/EstAPI.json. The setup sections (Post-Installation Step and Configuration) describe on-premises installs, so for cloud environments the ones to read are Usage, Testing, and Troubleshooting.

1. Use a Windows accountThe userName is the Windows account name of an Active Directory user who can access the Estimate data, written as DOMAIN\user.
2. Send both headersCredentials go in headers only. Both userName and password are required.
3. Copy the AccessTokenSend it as Authorization: Bearer <AccessToken> on every other call. The response also has a RefreshToken, which the docs say to ignore; it is there for future use.

$baseUrl = "https://<cluster>.b2w.trimble.com/EstAPI_<environment>"

# Windows (Active Directory) account of an Estimate user, as DOMAIN\user
$login = Invoke-RestMethod -Method Get -Uri "$baseUrl/Login" -Headers @{
    userName = "DOMAIN\jsmith"
    password = "<password>"
}

$token = $login.AccessToken   # this is your bearer token

curl -s 'https://<cluster>.b2w.trimble.com/EstAPI_<environment>/Login' \
  -H 'userName: DOMAIN\jsmith' \
  -H 'password: <password>'

GET /EstAPI_<environment>/Login HTTP/1.1
Host: <cluster>.b2w.trimble.com
userName: DOMAIN\jsmith
password: <password>

Is a token expired, or whose is it? Paste it into the token inspector. It shows when the token was issued and expires, and who it belongs to. It decodes the token on this page only and clears it when you close the window.

Client ID Security

Client ID Security is optional and set when the API is installed. When it is on, every call must include ClientID and ClientSecret headers that match the API’s values. If they don’t match, the call returns 401, the same code as a bad token.

Calls that need EstimateREF

These lookups return the values that can be used on one estimate, so they need the estimate’s ObjectID in an EstimateREF header:

• /Estimate/BidAs
• /Estimate/EquipmentRateClass
• /Estimate/EstimateType
• /Estimate/EstimateStatus
• /Estimate/JobCostID
• /Estimate/LaborRateClass
• /Estimate/MinorityType
• /Estimate/UserDefinedField
• /Estimate/WorkRule
• …/Organization/{Type}/Category for Competitor, Customer, EngineerArchitect, Manufacturer, Subcontractor, and Vendor

1. Download the collectionClick Download the Estimate collection. It is the official collection from the API docs, also linked under Testing Guidelines. It has 281 requests.
2. Import itIn Postman, press Ctrl+O and drop the file in. The EstAPI collection appears.
3. Fill in the variablesClick the collection, open Variables, set the values below, and save.
4. Send any requestStart with Ping, then any GET. The collection handles login and the extra headers.

$headers = @{
    Authorization = "Bearer $token"
    DatabaseName  = "<Estimate database name>"
    # ClientID     = "<client ID>"       # only when Client ID Security is on
    # ClientSecret = "<client secret>"
}

# For GET, -Body becomes the query string: /Estimate?$top=5
$result = Invoke-RestMethod -Uri "$baseUrl/Estimate" -Headers $headers -Body @{ '$top' = 5 }
$result.Items | Select-Object Number, Name, EstimateStatus

curl -s -G 'https://<cluster>.b2w.trimble.com/EstAPI_<environment>/Estimate' \
  --data-urlencode '$top=5' \
  -H 'Authorization: Bearer <AccessToken>' \
  -H 'DatabaseName: <Estimate database name>'

GET /EstAPI_<environment>/Estimate?$top=5 HTTP/1.1
Host: <cluster>.b2w.trimble.com
Authorization: Bearer <AccessToken>
DatabaseName: <Estimate database name>

The filter helper in the request builder lists each endpoint’s fields and writes the $filter for you, with text quoted, IDs left unquoted, and dates in the format the API expects.

{
  "Items": [
    {
      "AntiTamperToken": "string",
      "ObjectID": "32b66b04-0fdc-409f-8e10-aa6f5cf0fc6e",
      "Number": "0006",
      "Name": "Elm Street Bridge Improvements, Manchester",
      "EstimateStatus": "Signed",
      "EstimateType": "Public",
      "BidAs": "General Contractor",
      "BidDate": "2018-12-28T13:00:00",
      "PrimaryCustomerName": "City Of Manchester",
      "EstimatorName": "Paul Smith"
    }
  ]
}

Filter examples

# One estimate by number
{{BaseURL}}/Estimate?$filter=Number eq '0006'

# A few fields, sorted
{{BaseURL}}/Estimate?$select=ObjectID,Number,Name&$orderby=Number

# From the official collection: GUIDs go without quotes
{{BaseURL}}/Estimate/MinorityParticipationRequirement?$filter=EstimateREF eq 02E2BD02-B667-4478-A1C6-76DEDFB8958F

Why the AntiTamperToken matters

Every GET returns an AntiTamperToken. A PUT must send it back with the same value. It protects properties that are returned for information only, such as ObjectID, from being changed. The docs also warn that a PUT with missing fields can delete values from the fields you left out, which is why you always send the whole record.

# 1. GET the record you want to change
$result   = Invoke-RestMethod -Uri "$baseUrl/Estimate" -Headers $headers -Body @{ '$filter' = "Number eq '0006'" }
$estimate = $result.Items | Select-Object -First 1

# 2. Change only what you need. Leave AntiTamperToken and ObjectID as they are.
$estimate.BidLocation = "Manchester, NH"

# 3. PUT the whole record back
Invoke-RestMethod -Method Put -Uri "$baseUrl/Estimate" -Headers $headers -Body ($estimate | ConvertTo-Json -Depth 10) -ContentType "application/json"

Each card’s Build button opens that endpoint in the request builder, which adds the DatabaseName and EstimateREF headers for you and writes the request for Postman, PowerShell, cURL, or raw HTTP.

It knows the Estimate API’s own messages, such as “The user is not authorized for this API.” and “Operation is not allowed”. It also reads SQL Server errors like “Login failed for user ‘NT AUTHORITY\NETWORK SERVICE’”, and checks pasted request headers for a missing DatabaseName, EstimateREF, or Bearer. Decoding runs entirely in your browser.

1. App-up test

   GET /Ping/hello should return 200 and (server) hello|. If it doesn’t, check that IIS is running, that the EstAPI application pool is running, and that the URL is correct. The environment checker in question 2 runs this test for you.

2. Login test

   GET /Login with userName and password headers should return 200 and an AccessToken. Any other code points at the account (question 4).

3. Data call headers

   Check Authorization: Bearer, DatabaseName, the ClientID and ClientSecret if Client ID Security is on, and EstimateREF for estimate-specific lookups.

Common errors

The MR API v2 catalog lists 42 functional areas and 106 operations: a data call and a /schema call for each area, plus Login and Ping.

Check an environment

Enlarge

The machine-readable catalog is at /doc/v2/MRAPI.json.

$baseUrl = "https://<cluster>.b2w.trimble.com/MRAPI_<environment>"

$login = Invoke-RestMethod -Method Get -Uri "$baseUrl/Login" -Headers @{
    userName = "DOMAIN\jsmith"
    password = "<password>"
}

$token = $login.AccessToken

curl -s 'https://<cluster>.b2w.trimble.com/MRAPI_<environment>/Login' \
  -H 'userName: DOMAIN\jsmith' \
  -H 'password: <password>'

GET /MRAPI_<environment>/Login HTTP/1.1
Host: <cluster>.b2w.trimble.com
userName: DOMAIN\jsmith
password: <password>

The responses match the Estimate API: 200 with the AccessToken, 400 when a header is missing (the API answers "Both userName and password must be specified in the request header"), 401 when the user is not authorized, and 500 for server errors.

Is a token expired, or whose is it? Paste it into the token inspector. It shows when the token was issued and expires, and who it belongs to. It decodes the token on this page only and clears it when you close the window.

Calls that need EstimateREF

The Detail versions return the same items with full information. Get an estimate’s ObjectID from GET /Estimate first.

1. Download the collectionClick Download the MR collection. It is the official collection from the API docs, also linked under Testing Guidelines. It has 107 requests.
2. Import itPress Ctrl+O in Postman and drop the file in.
3. Fill in the variablesSet the values below on the collection’s Variables tab and save.

$headers = @{
    Authorization = "Bearer $token"
    DatabaseName  = "<Data Warehouse database name>"
    EstimateREF   = "<ObjectID of the estimate>"
}

$result = Invoke-RestMethod -Uri "$baseUrl/Estimate/PayItem" -Headers $headers -Body @{ '$filter' = "contains(Description, 'Mobilization')" }
$result.Items
$result.Pagination   # CurrentPage, ItemsOnPage, PageSize, TotalItems

curl -s -G 'https://<cluster>.b2w.trimble.com/MRAPI_<environment>/Estimate/PayItem' \
  --data-urlencode "\$filter=contains(Description, 'Mobilization')" \
  -H 'Authorization: Bearer <AccessToken>' \
  -H 'DatabaseName: <Data Warehouse database name>' \
  -H 'EstimateREF: <ObjectID of the estimate>'

GET /MRAPI_<environment>/Estimate/PayItem?$filter=contains(Description, 'Mobilization') HTTP/1.1
Host: <cluster>.b2w.trimble.com
Authorization: Bearer <AccessToken>
DatabaseName: <Data Warehouse database name>
EstimateREF: <ObjectID of the estimate>

The filter helper in the request builder lists each endpoint’s fields and writes the $filter for you, with text quoted, IDs left unquoted, and dates in the format the API expects.

{
  "Items": [
    {
      "Title": "Fox Hill Development",
      "ObjectID": "02e2bd02-b667-4478-a1c6-76dedfb8958f",
      "EstimateNumber": "0012",
      "BidNumber": "64687",
      "EstimateStatus": "Pending",
      "SourceDatabaseName": "B2WSample",
      "LastRetrievedFromSourceDatabaseOn": "2025-12-07T23:40:17.823",
      "TotalBidPriceWithTax": 12627661.59
    }
  ],
  "Pagination": {
    "CurrentPage": "…/Estimate?$orderBy=Title&$skip=0&$top=5",
    "ItemsOnPage": 1,
    "PageSize": 5,
    "TotalItems": 1
  }
}

Each card’s Build button opens that endpoint in the request builder, which adds the DatabaseName and EstimateREF headers for you and writes the request for Postman, PowerShell, cURL, or raw HTTP.

It knows the MR API’s messages and SQL Server errors such as “Login failed for user ‘NT AUTHORITY\NETWORK SERVICE’”. Paste a successful response and it reads the Pagination block and LastRetrievedFromSourceDatabaseOn too, which answers “why is data missing?” and “why are the numbers old?”. Decoding runs entirely in your browser.

1. App-up test

   GET /Ping/hello should return 200 and (server) hello|. If not, check that IIS and the MRAPI application pool are running and that the URL is correct. The environment checker in question 2 runs this for you.

2. Login test

   GET /Login with userName and password headers should return an AccessToken.

3. Data call headers

   Check Authorization: Bearer, DatabaseName, the client values if Client ID Security is on, and EstimateREF on estimate-specific calls.

Common errors