How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Broadlume Customer API

The Customer API from Broadlume — 26 operation(s) for customer.

Broadlume Customer API is one of 28 APIs that Broadlume publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 39 operations across 26 paths. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.rmaster.com/api.

39 operations 26 paths 0 schemas 3 DELETE24 GET6 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.rmaster.com/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Broadlume Customer API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (apiKeyAuth). An API key is passed in the header as token (sessionToken). By default, every request must be authenticated.

  • apiKeyAuth — API key issued by Broadlume, required on every request.
  • sessionToken — User session token obtained from POST /{alias}/token. Sessions expire after a server-specified idle timeout (default 5 minutes); refresh with the keepalive end…

Paths & Operations 39

Across 26 paths, the API surfaces 39 operations — 3 DELETE, 24 GET, 6 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Customer 39
GET
/{alias}/customers
Customer List
customerList 11 params → 200
GET
/{alias}/customer
Customer info
customerInfo 4 params → 200
POST
/{alias}/customer
Customer info
customerInfo1 1 param body → 200
PATCH
/{alias}/customer
Customer info
customerInfo2 1 param body → 200
GET
/{alias}/customersearchbyphone
Customer Search
customerSearch 5 params → 200
GET
/{alias}/customersearch
Customer Search
customerSearch1 7 params → 200
GET
/{alias}/customerproperties
Customer Properties
customerProperties 3 params → 200
GET
/{alias}/customerpropertymanagers
Customer Property Managers
customerPropertyManagers 2 params → 200
GET
/{alias}/customerinvoices
Customer Invoices
customerInvoices 7 params → 200
GET
/{alias}/customer5year
Customer 5 Year Sales
customer5YearSales 4 params → 200
GET
/{alias}/customerARcontacts
Customer AR Contacts
customerArContacts 3 params → 200
POST
/{alias}/customercontact
Creates Customer Contact
createsCustomerContact 1 param body → 200
PATCH
/{alias}/customercontact
Updates Existing Customer Contact
updatesExistingCustomerContact 12 params → 200
GET
/{alias}/customerARnotes
Customer AR Contact Notes
customerArContactNotes 3 params body → 200
POST
/{alias}/ customerARnotes
Create Customer AR Contact Notes
createCustomerArContactNotes 1 param body → 200
PATCH
/{alias}/ customerARnotes
Update Customer AR Contact Notes
updateCustomerArContactNotes 1 param body → 200
GET
/{alias}/ ContactNotesbyID
All Customer Contact Notes
allCustomerContactNotes 3 params → 200
GET
/{alias}/customersaleslist
Customer Sales
customerSales 3 params → 200
GET
/{alias}/roleList
Get Contact Role List
getContactRoleList 2 params → 200
GET
/{alias}/shipto
Ship To Information
shipToInformation 5 params → 200
GET
/{alias}/customershiptos
Customer Ship To Codes
customerShipToCodes 5 params → 200
GET
/{alias}/payhist
Payment History
paymentHistory 5 params → 200
GET
/{alias}/aropenitem
AR Open Items
arOpenItems 5 params → 200
GET
/{alias}/shiptocodes
Ship To Code List
shipToCodeList 4 params → 200
GET
/{alias}/nationalpropertymanagers
Get list of national property manager relationships
getListOfNationalPropertyManagerRelationships 2 params → 200
POST
/{alias}/customernotes
Creates a Customer Note
createsACustomerNote 1 param body → 200
PATCH
/{alias}/customernotes
Edits a Customer Note
editsACustomerNote 6 params → 200
GET
/{alias}/customernotes
Reads a Customer Note
readsACustomerNote 3 params → 200
DELETE
/{alias}/customernotes
Erases a Customer Note
erasesACustomerNote 5 params → 200
POST
/{alias}/salesnotes
Creates a Sales Note
createsASalesNote 1 param body → 200
PATCH
/{alias}/salesnotes
Edits a Sales Note
editsASalesNote 4 params → 200
GET
/{alias}/salesnotes
Reads a Sales Note
readsASalesNote 3 params → 200
DELETE
/{alias}/salesnotes
Erases a Sales Note
erasesASalesNote 3 params → 200
POST
/{alias}/shiptonotes
Creates a Customer Note by ShipTo Code - Inactive until 2102 Release
createsACustomerNoteByShiptoCodeInactiveUntil2102Release 1 param body → 200
PATCH
/{alias}/shiptonotes
Updates a Customer Note by ShipTo Code - Inactive until 2102 Release
updatesACustomerNoteByShiptoCodeInactiveUntil2102Release 6 params body → 200
GET
/{alias}/shiptonotes
Gets all Customer Note by ShipTo Code - Inactive until 2102 Release
getsAllCustomerNoteByShiptoCodeInactiveUntil2102Release 3 params body → 200
DELETE
/{alias}/shiptonotes
Erases a Customer Note by ShipTo Code - Inactive until 2102 Release
erasesACustomerNoteByShiptoCodeInactiveUntil2102Release 5 params body → 200
GET
/{alias}/customersearchbyemail
Customer Search
customerSearch2 5 params → 200
GET
/{alias}/customercreditstats
Get List of possible customer credit status codes
getListOfPossibleCustomerCreditStatusCodes 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

broadlume-customer-api-openapi.yml Raw ↑

Other APIs Broadlume publishes across the network.

Broadlume Accounts Receivable API
Broadlume Audit API
Broadlume Authentication API
Broadlume Build Order API
Broadlume Bundle API
Broadlume Charge It Pro API
Broadlume Committed API
Broadlume Company API
Broadlume Dashboard API
Broadlume Edocs API
Broadlume General API
Broadlume General Ledger API
Where this information came from

This is an independent, third-party profile of Broadlume Customer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.