Broadlume

Broadlume Lead API

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

GitHub OpenAPI

Operations 33

GET /{alias}/leadtimeslots Lead Time Slots #
GET /{alias}/leadsbydate Leads list #
POST /{alias}/lead Creates Lead #
PATCH /{alias}/lead Update lead #
GET /{alias}/lead Lead detail #
POST /{alias}/leadnotes Updates Lead Notes #
POST /{alias}/leadquicknote Updates Lead Quick Note #
POST /{alias}/leaddispoqty Updates Lead Disp Style/Quantity Notes #
POST /{alias}/leaddispo Updates Lead Dispo Notes #
GET /{alias}/leadnonq Lead Nonqualified Categories #
PATCH /{alias}/leadnonq Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead. #
GET /{alias}/leadzone Lead Zone Categories #
GET /{alias}/terrsub Subterritory Categories #
GET /{alias}/leadexceptions Lead Exception Categories #
GET /{alias}/leadofficenotes Lead Office Notes Categories #
POST /{alias}/leadofficenotes Create Lead Office Notes #
PATCH /{alias}/leadofficenotes Update Lead Office Notes #
GET /{alias}/leadsched Lead Scheduling Categories #
GET /{alias}/nonqualified Nonqualified Categories #
GET /{alias}/leadmattype Lead Mat Type Categories #
GET /{alias}/leadappt Lead Appointments #
POST /{alias}/leadproductnotes Create Lead Product Notes #
PATCH /{alias}/leadproductnotes Updates Lead Product Notes #
GET /{alias}/leadproductnotes Gets Lead Product Notes #
DELETE /{alias}/leadproductnotes Deletes Lead Product Notes #
GET /{alias}/leadroom Get Lead Room #
POST /{alias}/leadroom Create Lead Room #
PATCH /{alias}/leadroom Update Lead Room #
DELETE /{alias}/leadroom Remove Lead Room #
GET /{alias}/roomfile Room File #
GET /{alias}/allavailability Get All Availability #
GET /{alias}/leadspecials Get Lead Specials #
POST /{alias}/convertleadtoquote Converts an existing lead into a quote #

Documentation

📖
Documentation
https://developer.broadlume.com/bms
📖
APIReference
https://developer.broadlume.com/bms
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/authentication/broadlume-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/openapi/broadlume-lead-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/conventions/broadlume-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/errors/broadlume-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/data-model/broadlume-data-model.yml
🔗
Console
https://developer.broadlume.com/api-runner/broadlume/bms

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/broadlume-lead-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

broadlume-lead-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Broadlume BMS Lead API
  version: v1
  summary: Business management API for Broadlume BMS, the flooring ERP formerly known as RollMaster.
  description: 'REST API for Broadlume BMS (formerly RollMaster), Broadlume''s business management system for flooring retailers. Covers orders, quotes, leads, customers, products and catalog, inventory, purchase orders, invoicing, accounts receivable, general ledger, installation scheduling, e-documents, handheld/barcode operations, dashboards and reporting.


    Transcribed by API Evangelist from Broadlume''s own published developer portal at https://developer.broadlume.com/bms — paths, methods, parameters and response fields are taken verbatim from that reference. Broadlume acquired RollMaster in November 2021, which is why the documented base URL remains api.rmaster.com.'
  contact:
    name: Broadlume Developer Portal
    url: https://developer.broadlume.com/bms
servers:
- url: https://api.rmaster.com/api
  description: Production
security:
- apiKeyAuth: []
  sessionToken: []
tags:
- name: Lead
paths:
  /{alias}/leadtimeslots:
    get:
      operationId: leadTimeSlots
      summary: Lead Time Slots
      tags:
      - Lead
      description: Get lead time slot list
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/leadsbydate:
    get:
      operationId: leadsList
      summary: Leads list
      tags:
      - Lead
      description: Leads list by date range
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: status
        in: query
        required: false
        schema:
          type: string
          default: both
          enum:
          - open
          - closed
          - both
        description: Optional Lead status
      - name: startdate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Optional Appointment Date
      - name: enddate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Optional Appointment Date
      - name: startdate2
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Optional Last Edited Date
      - name: enddate2
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Optional Last Edited Date
      - name: startdate3
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Optional Created Date
      - name: enddate3
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Format - YYYYMMDD - Optional Created Date
      - name: term
        in: query
        required: false
        schema:
          type: string
          maxLength: 30
        description: Optional Search term for customer name
      - name: ordstatuscode
        in: query
        required: false
        schema:
          type: string
          maxLength: 10
        description: Optional
      - name: page
        in: query
        required: false
        schema:
          type: number
          maxLength: 4
          default: '1'
        description: Used to offset data by 'page'. Used in conjunction with 'pagelimit' parameter to limit the amount of records per page.
      - name: pagelimit
        in: query
        required: false
        schema:
          type: number
          maxLength: 4
          default: '1000'
        description: Limit of records allowed per 'page' of data. Used with the 'page' parameter to offset records and get chunks of a return.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/lead:
    post:
      operationId: createsLead
      summary: Creates Lead
      tags:
      - Lead
      description: Creates Lead
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: rooms[]
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
        description: Selected Rooms
      - name: pctypes[]
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
        description: Selected Product Types
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                jobstat:
                  type: string
                  maxLength: 10
                  description: Lead status
                leadfirstname:
                  type: string
                  maxLength: 20
                leadlastname:
                  type: string
                  maxLength: 20
                shaddr1:
                  type: string
                  maxLength: 30
                shaddr2:
                  type: string
                  maxLength: 30
                shcity:
                  type: string
                  maxLength: 30
                shstate:
                  type: string
                  maxLength: 30
                shzip:
                  type: string
                  maxLength: 30
                  description: Required when company control is on.
                leadphone1:
                  type: string
                  maxLength: 12
                  description: Format - 111-111-1111.
                text1:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                leadphone2:
                  type: string
                  maxLength: 12
                  description: Format - 111-111-1111
                text2:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                leadphone3:
                  type: string
                  maxLength: 12
                  description: Format - 111-111-1111
                text3:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                leademail:
                  type: string
                  maxLength: 120
                  description: Required when company control is on.
                date:
                  type: string
                  maxLength: 8
                  description: Format - YYYYMMDD
                leadtime:
                  type: string
                  maxLength: 8
                ordsalesrep1:
                  type: string
                  maxLength: 3
                special:
                  type: string
                  maxLength: 20
                territory:
                  type: string
                  maxLength: 8
                quicknote:
                  type: string
                  maxLength: 30
                po:
                  type: string
                  maxLength: 13
                canceled:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                duplicate:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                otherfirst:
                  type: string
                  maxLength: 20
                otherlast:
                  type: string
                  maxLength: 20
                crossstreets:
                  type: string
                  maxLength: 20
                commcode:
                  type: string
                  maxLength: 2
                zone:
                  type: string
                  maxLength: 10
                married:
                  type: string
                  maxLength: 1
                  description: Y for Yes N for No
                homeowner:
                  type: string
                  maxLength: 1
                  description: Y for Yes N for No
                subterritory:
                  type: string
                  maxLength: 10
                budget:
                  type: string
                  maxLength: 8
                gclid:
                  type: string
              required:
              - company
              - branch
              - leadfirstname
              - leadlastname
              - shaddr1
              - shcity
              - shstate
              - leadphone1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  LEAD_UPDATED:
                    type: string
    patch:
      operationId: updateLead
      summary: Update lead
      tags:
      - Lead
      description: Update lead
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: leadno
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
      - name: rooms[]
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
        description: Selected Rooms
      - name: pctypes[]
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
        description: Selected Product Types
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                jobstat:
                  type: string
                  maxLength: 10
                  description: Lead status
                leadfirstname:
                  type: string
                  maxLength: 20
                leadlastname:
                  type: string
                  maxLength: 20
                shaddr1:
                  type: string
                  maxLength: 30
                shaddr2:
                  type: string
                  maxLength: 30
                shcity:
                  type: string
                  maxLength: 30
                shstate:
                  type: string
                  maxLength: 30
                shzip:
                  type: string
                  maxLength: 30
                  description: Required when company control is on.
                leadphone1:
                  type: string
                  maxLength: 12
                  description: Format - 111-111-1111.
                text1:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                leadphone2:
                  type: string
                  maxLength: 12
                  description: Format - 111-111-1111
                text2:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                leadphone3:
                  type: string
                  maxLength: 12
                  description: Format - 111-111-1111
                text3:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                leademail:
                  type: string
                  maxLength: 120
                  description: Required when company control is on.
                date:
                  type: string
                  maxLength: 8
                  description: Format - YYYYMMDD
                leadtime:
                  type: string
                  maxLength: 8
                ordsalesrep1:
                  type: string
                  maxLength: 3
                special:
                  type: string
                  maxLength: 20
                territory:
                  type: string
                  maxLength: 8
                quicknote:
                  type: string
                  maxLength: 30
                po:
                  type: string
                  maxLength: 13
                canceled:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                duplicate:
                  type: string
                  maxLength: 1
                  description: 1 for Yes 0 for No
                otherfirst:
                  type: string
                  maxLength: 20
                otherlast:
                  type: string
                  maxLength: 20
                crossstreets:
                  type: string
                  maxLength: 20
                commcode:
                  type: string
                  maxLength: 2
                zone:
                  type: string
                  maxLength: 10
                married:
                  type: string
                  maxLength: 1
                  description: Y for Yes N for No
                homeowner:
                  type: string
                  maxLength: 1
                  description: Y for Yes N for No
                subterritory:
                  type: string
                  maxLength: 10
                budget:
                  type: string
                  maxLength: 8
                gclid:
                  type: string
              required:
              - company
              - branch
              - leadfirstname
              - leadlastname
              - shaddr1
              - shcity
              - shstate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  LEAD_CODIV:
                    type: string
                  LEAD_WHSE:
                    type: string
                  LEAD_NUMBER:
                    type: string
                  LEAD_STATUS:
                    type: string
                  LEAD_STATUS_CODE:
                    type: string
                  LEAD_DATE:
                    type: string
                  LEAD_CUST_FIRST_NAME:
                    type: string
                  LEAD_CUST_LAST_NAME:
                    type: string
                  LEAD_CUST_ADDR1:
                    type: string
                  LEAD_CUST_ADDR2:
                    type: string
                  LEAD_CUST_CITY:
                    type: string
                  LEAD_CUST_STATE:
                    type: string
                  LEAD_CUST_ZIPCD:
                    type: string
                  LEAD_CUST_PHONE1:
                    type: string
                  LEAD_CUST_PHONE2:
                    type: string
                  LEAD_CUST_PHONE3:
                    type: string
                  LEAD_CUST_EMAIL:
                    type: string
                  LEAD_SCHEDULE_DATE:
                    type: string
                  LEAD_SCHEDULE_TIME:
                    type: string
                  LEAD_SCHEDULE_SLSREP:
                    type: string
                  LEAD_SPECIAL_CODE:
                    type: string
                  LEAD_TERRITORY:
                    type: string
                  LEAD_NOTE:
                    type: string
                  LEAD_USER:
                    type: string
                  LEAD_PONO:
                    type: string
                  LEAD_DMO_ORDNO:
                    type: string
                  LEAD_QMO_ORDNO:
                    type: string
                  LEAD_REOPEN:
                    type: string
                  LEAD_CANCELLED:
                    type: string
                  LEAD_DUPLICATE:
                    type: string
    get:
      operationId: leadDetail
      summary: Lead detail
      tags:
      - Lead
      description: Specific Lead information
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster branch.
      - name: leadno
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/leadnotes:
    post:
      operationId: updatesLeadNotes
      summary: Updates Lead Notes
      tags:
      - Lead
      description: Updates Lead Notes
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                leadno:
                  type: string
                  maxLength: 8
                  description: Format - lead number
                noteslist:
                  type: array
                  items:
                    type: array
                    items:
                      type: string
              required:
              - company
              - branch
              - leadno
              - noteslist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  LEAD_UPDATED:
                    type: string
  /{alias}/leadquicknote:
    post:
      operationId: updatesLeadQuickNote
      summary: Updates Lead Quick Note
      tags:
      - Lead
      description: Updates Lead Quick Note
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                leadno:
                  type: string
                  maxLength: 8
                  description: Format - lead number
                noteslist:
                  type: array
                  items:
                    type: array
                    items:
                      type: string
              required:
              - company
              - branch
              - leadno
              - noteslist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  LEAD_UPDATED:
                    type: string
  /{alias}/leaddispoqty:
    post:
      operationId: updatesLeadDispStyleQuantityNotes
      summary: Updates Lead Disp Style/Quantity Notes
      tags:
      - Lead
      description: Updates Lead Disp Style/Quantity Notes
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                leadno:
                  type: string
                  maxLength: 8
                  description: Format - lead number
                noteslist:
                  type: array
                  items:
                    type: array
                    items:
                      type: string
              required:
              - company
              - branch
              - leadno
              - noteslist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  LEAD_UPDATED:
                    type: string
  /{alias}/leaddispo:
    post:
      operationId: updatesLeadDispoNotes
      summary: Updates Lead Dispo Notes
      tags:
      - Lead
      description: Updates Lead Dispo Notes
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
                leadno:
                  type: string
                  maxLength: 8
                  description: Format - lead number
                noteslist:
                  type: array
                  items:
                    type: array
                    items:
                      type: string
              required:
              - company
              - branch
              - leadno
              - noteslist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  LEAD_UPDATED:
                    type: string
  /{alias}/leadnonq:
    get:
      operationId: leadNonqualifiedCategories
      summary: Lead Nonqualified Categories
      tags:
      - Lead
      description: Lead Nonqualified Categories - Alert Codes
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: false
        schema:
          type: string
          maxLength: 2
        description: Optional
      - name: leadno
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Optional
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
    patch:
      operationId: updatesNonqualifiersOnALeadSendingExistingDescriptionWillRemoveFromALead
      summary: Updates Nonqualifiers on a Lead. Sending existing description will remove from a lead.
      tags:
      - Lead
      description: Updates an existing Lead Office Note. Returns success message.
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: leadno
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
      - name: nonqdesc
        in: query
        required: true
        schema:
          type: string
          maxLength: 20
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: string
                  maxLength: 2
                  description: RollMaster company.
                branch:
                  type: string
                  maxLength: 2
                  description: RollMaster branch.
              required:
              - company
              - branch
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/leadzone:
    get:
      operationId: leadZoneCategories
      summary: Lead Zone Categories
      tags:
      - Lead
      description: Lead zones
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: false
        schema:
          type: string
          maxLength: 2
        description: Optional, gets branch specific lead zone info when applicable.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/terrsub:
    get:
      operationId: subterritoryCategories
      summary: Subterritory Categories
      tags:
      - Lead
      description: Subterritories
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: territory
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Optional - enter to return details about one territory
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/leadexceptions:
    get:
      operationId: leadExceptionCategories
      summary: Lead Exception Categories
      tags:
      - Lead
      description: Scheduling slot exceptions for lead sales reps
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster branch.
      - name: zone
        in: query
        required: false
        schema:
          type: string
          maxLength: 10
        description: Optional
      - name: salesid
        in: query
        required: false
        schema:
          type: string
          maxLength: 3
        description: Optional
      - name: startdate
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
        description: Optional. Format - YYYYMMDD
      - name: enddate
        in: query
        required: false
        schema:
          type: string
          maxLength: 8
        description: Optional. Format - YYYYMMDD
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
  /{alias}/leadofficenotes:
    get:
      operationId: leadOfficeNotesCategories
      summary: Lead Office Notes Categories
      tags:
      - Lead
      description: Get Lead Office Notes
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      - name: company
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster company.
      - name: branch
        in: query
        required: true
        schema:
          type: string
          maxLength: 2
        description: RollMaster branch.
      - name: leadno
        in: query
        required: true
        schema:
          type: string
          maxLength: 8
      - name: leadpage
        in: query
        required: false
        schema:
          type: string
          maxLength: 2
        description: Optional - Lead Office Note Page Number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '0':
                    type: array
                    items:
                      type: string
    post:
      operationId: createLeadOfficeNotes
      summary: Create Lead Office Notes
      tags:
      - Lead
      description: Creates a new Lead Office Note. Returns success message.
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          type: string
        description: The clientid for the API call.
      requestBody:
        required: true
        content:
          application

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/broadlume/refs/heads/main/openapi/broadlume-lead-api-openapi.yml