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 Lead API

The Lead API from Broadlume — 22 operation(s) for lead.

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

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

This API exposes 33 operations across 22 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.

33 operations 22 paths 0 schemas 2 DELETE17 GET5 PATCH9 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 Lead 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 33

Across 22 paths, the API surfaces 33 operations — 2 DELETE, 17 GET, 5 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Lead 33
GET
/{alias}/leadtimeslots
Lead Time Slots
leadTimeSlots 2 params → 200
GET
/{alias}/leadsbydate
Leads list
leadsList 13 params → 200
POST
/{alias}/lead
Creates Lead
createsLead 3 params body → 200
PATCH
/{alias}/lead
Update lead
updateLead 4 params body → 200
GET
/{alias}/lead
Lead detail
leadDetail 4 params → 200
POST
/{alias}/leadnotes
Updates Lead Notes
updatesLeadNotes 1 param body → 200
POST
/{alias}/leadquicknote
Updates Lead Quick Note
updatesLeadQuickNote 1 param body → 200
POST
/{alias}/leaddispoqty
Updates Lead Disp Style/Quantity Notes
updatesLeadDispStyleQuantityNotes 1 param body → 200
POST
/{alias}/leaddispo
Updates Lead Dispo Notes
updatesLeadDispoNotes 1 param body → 200
GET
/{alias}/leadnonq
Lead Nonqualified Categories
leadNonqualifiedCategories 4 params → 200
PATCH
/{alias}/leadnonq
Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead.
updatesNonqualifiersOnALeadSendingExistingDescriptionWillRemoveFromALead 3 params body → 200
GET
/{alias}/leadzone
Lead Zone Categories
leadZoneCategories 3 params → 200
GET
/{alias}/terrsub
Subterritory Categories
subterritoryCategories 3 params → 200
GET
/{alias}/leadexceptions
Lead Exception Categories
leadExceptionCategories 7 params → 200
GET
/{alias}/leadofficenotes
Lead Office Notes Categories
leadOfficeNotesCategories 5 params → 200
POST
/{alias}/leadofficenotes
Create Lead Office Notes
createLeadOfficeNotes 1 param body → 200
PATCH
/{alias}/leadofficenotes
Update Lead Office Notes
updateLeadOfficeNotes 4 params body → 200
GET
/{alias}/leadsched
Lead Scheduling Categories
leadSchedulingCategories 6 params → 200
GET
/{alias}/nonqualified
Nonqualified Categories
nonqualifiedCategories 2 params → 200
GET
/{alias}/leadmattype
Lead Mat Type Categories
leadMatTypeCategories 2 params → 200
GET
/{alias}/leadappt
Lead Appointments
leadAppointments 8 params → 200
POST
/{alias}/leadproductnotes
Create Lead Product Notes
createLeadProductNotes 1 param body → 200
PATCH
/{alias}/leadproductnotes
Updates Lead Product Notes
updatesLeadProductNotes 9 params → 200
GET
/{alias}/leadproductnotes
Gets Lead Product Notes
getsLeadProductNotes 4 params → 200
DELETE
/{alias}/leadproductnotes
Deletes Lead Product Notes
deletesLeadProductNotes 5 params → 200
GET
/{alias}/leadroom
Get Lead Room
getLeadRoom 2 params body → 200
POST
/{alias}/leadroom
Create Lead Room
createLeadRoom 1 param body → 200
PATCH
/{alias}/leadroom
Update Lead Room
updateLeadRoom 4 params body → 200
DELETE
/{alias}/leadroom
Remove Lead Room
removeLeadRoom 3 params body → 200
GET
/{alias}/roomfile
Room File
roomFile 2 params body → 200
GET
/{alias}/allavailability
Get All Availability
getAllAvailability 7 params → 200
GET
/{alias}/leadspecials
Get Lead Specials
getLeadSpecials 2 params → 200
POST
/{alias}/convertleadtoquote
Converts an existing lead into a quote
convertsAnExistingLeadIntoAQuote 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

broadlume-lead-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 Customer API
Broadlume Dashboard API
Broadlume Edocs API
Broadlume General API
Where this information came from

This is an independent, third-party profile of Broadlume Lead 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.