GoldLeaf DocumentationGoldLeaf Documentation
User Guide
API
User Guide
API
  • Getting Started

    • Introduction
    • API Key Types
    • Configuration
    • Limitations
  • E-Commerce Configurator

    • Introduction
    • Security Tokens
    • Setting up the Configurator
  • API Endpoints

    • Adaptor

      • [GET]adaptors-cross
      • [GET]adaptors-search
      • [GET]adaptor-{adaptorId}
      • [GET]adaptors-configuration
      • [POST]adaptors-create
      • [GET]organization-adaptors
      • [GET]organization-customadaptors
      • [POST]organization-adaptor-{adaptorId}-update
    • Brand

      • [GET]brands
      • [GET]hosebrands
      • [GET]adaptorbrands
      • [GET]wrapbrands
      • [GET]otheritembrands
      • [GET]brandnames
      • [POST]brand-{brandId}-delete
      • [POST]brand-{brandId}-update
      • [POST]brands-export
      • [GET]organization-defaultbrand
      • [GET]organization-defaultadaptorbrand
    • Component

      • [POST]components-import
      • [POST]components-exceltemplate
      • [POST]components-export
      • [GET]organization-components
    • CrimpFitting

      • [POST]crimpfittings-sizes
      • [POST]crimpfittings-create
      • [GET]crimpfitting-{crimpfittingId}
      • [POST]organization-crimpfitting-{crimpfittingId}-update
      • [GET]organization-couplingseries
      • [GET]organization-couplingseriesdetails
      • [GET]organization-crimpfittings
      • [GET]organization-crimpfittingswithferrules
      • [GET]organization-customcrimpfittings
    • Customer

      • [GET]customers
      • [GET]customernamess
      • [POST]customers-create
      • [GET]customer-{customerId}
      • [POST]customer-{customerId}-update
      • [POST]customer-{customerId}-delete
      • [POST]customers-exceltemplate
      • [POST]customers-export
      • [GET]customer-{customerId}-items
      • [POST]customer-{customerId}-item-{itemId}-update
      • [POST]customer-{customerId}-item-{itemId}-delete
      • [POST]customers-items-import
      • [POST]customers-items-exceltemplate
      • [POST]customer-{customerId}-items-export
      • [GET]customer-{customerId}-locations
      • [POST]customer-{customerId}-location-{locationId}-update
      • [POST]customer-{customerId}-location-{locationId}-delete
    • Ferrule

      • [POST]ferrules-create
      • [GET]ferrule-{ferruleId}
      • [GET]organization-ferrule
      • [POST]organization-ferrule-{ferruleId}-update
      • [GET]organization-ferrules
      • [GET]organization-customferrules
    • Gender

      • [GET]genders
    • Hose

      • [POST]hoses-sizes
      • [POST]hoses-create
      • [GET]hose-{hoseId}
      • [GET]hose-{hoseId}-crimpspecs
      • [POST]organization-hose-{hoseId}-update
      • [GET]organization-hoses
      • [GET]organization-customhoses
      • [GET]organization-hasparker
    • HoseAssembly

      • [POST]hoseassemblies-checkexisting
      • [POST]hoseassemblies-create
      • [POST]hoseassembly-:hoseAssemblyId-datasheet
      • [POST]hoseassembly-{hoseAssemblyId}-label
      • [GET]hoseassemblies
      • [GET]hoseassembly-{hoseAssemblyId}
      • [GET]hoseassemblies-parse
      • [POST]hoseassemblies-parsefeedback
      • [POST]hoseassembly-{hoseAssemblyId}-saveas
      • [POST]hoseassembly-:hoseAssemblyId-update
      • [POST]hoseassembly-:hoseAssemblyId-delete
      • [POST]hoseassembly-{hoseAssemblyId}-customers-update
      • [POST]hoseassembly-{hoseAssemblyId}-customers-delete
      • [POST]hoseassemblies-import
      • [POST]hoseassemblies-exceltemplate
      • [POST]hoseassemblies-export
      • [POST]hoseassembly-{hoseAssemblyId}-getBillOfMaterials
      • [POST]hoseassembly-{hoseAssemblyId}-getmarkenfile
      • [POST]hoseassembly-{hoseAssemblyId}-getparkerptsfile
      • [POST]hoseassembly-{hoseAssemblyId}-price
      • [POST]hoseassembly-price
      • [POST]hoseassembly-{hoseAssemblyId}-release
      • [POST]hoseassembly-{hoseAssemblyId}-unrelease
      • [POST]hoseassembly-{hoseAssemblyId}-obsolete
      • [POST]hoseassembly-{hoseAssemblyId}-newversion
      • [POST]hoseassembly-{hoseAssemblyId}-rollback
      • [POST]hoseassembly-{hoseAssemblyId}-revise
    • HoseKit

      • [POST]hosekits-checkexisting
      • [POST]hosekits-create
      • [GET]hosekits
      • [GET]hosekit-{hoseKitId}
      • [POST]hosekit-{hoseKitId}-update
      • [POST]hosekit-{hoseKitId}-release
      • [POST]hosekit-{hoseKitId}-newversion
      • [POST]hosekit-{hoseKitId}-rollback
      • [POST]hosekit-{hoseKitId}-revise
      • [POST]hosekit-{hoseKitId}-delete
      • [POST]hosekit-{hoseKitId}-addhoseassembly
      • [POST]hosekit-{hoseKitId}-addadaptor
      • [POST]hosekit-{hoseKitId}-addotheritem
      • [GET]hosekit-{hoseKitId}-hoseassemblies
      • [GET]hosekit-{hoseKitId}-adaptors
      • [GET]hosekit-{hoseKitId}-otheritems
      • [GET]hosekit-{hoseKitId}-allitems
      • [POST]hosekit-{hoseKitId}-item-{itemId}-delete
      • [POST]hosekit-{hoseKitId}-hoseassembly-{itemId}-update
      • [POST]hosekit-{hoseKitId}-adaptor-{itemId}-update
      • [POST]hosekit-{hoseKitId}-otheritem-{itemId}-update
      • [POST]hosekit-:hoseKitId-getHoseKitDataSheet
      • [POST]hosekit-{hoseKitId}-getBillOfMaterials
      • [POST]hosekit-{hoseKitId}-getmarkenfile
      • [POST]hosekit-{hoseKitId}-getparkerptsfile
      • [POST]hosekits-export
      • [POST]hosekit-{hoseKitId}-labels
      • [POST]hosekit-{hoseKitId}-price
    • Image

      • [GET]image-{belongsToId}
    • Inventory

      • [GET]inventory
      • [POST]inventory-import
      • [POST]inventory-exceltemplate
      • [POST]inventoryitems-export
      • [POST]inventoryitem-{inventoryItemId}-delete
      • [POST]inventoryitem-update
      • [GET]organization-hideinventory
    • Item

      • [GET]item-{itemId}
      • [GET]organization-items
      • [GET]organization-itemtypes
      • [GET]organization-pendingitems
      • [POST]organization-item-{itemId}-update
    • Organization

      • [GET]organization
      • [POST]organization-update
      • [GET]organization-defaults
      • [GET]organization-currencies
      • [POST]organization-currencies-update
      • [GET]organization-subscription
      • [GET]organization-erpname
      • [GET]organization-usebetafeatures
      • [POST]organization-acceptterms
      • [GET]organization-hasacceptedterms
      • [POST]organization-productgroups-update
      • [POST]organization-suppliers-update
      • [POST]organization-locations-update
      • [GET]organization-productgroups
      • [GET]organization-suppliers
      • [GET]organization-locations
      • [GET]organization-apikeys
      • [POST]organization-apikeys-{apiKeyId}-update
      • [POST]organization-apikeys-{apiKeyId}-delete
      • [GET]organization-nextpartnumber
      • [GET]organization-revisiondelimiter
      • [GET]organization-api-history
    • OtherItem

      • [POST]otheritems-create
      • [POST]otheritems-{itemId}-delete
      • [POST]otheritems-{itemId}-update
      • [GET]otheritem-{otherItemId}
      • [POST]organization-otheritem-{otherItemId}-update
      • [GET]organization-customotheritems
    • PriceList

      • [GET]pricelists
      • [GET]pricelistnames
      • [POST]pricelists-create
      • [GET]pricelist-{priceListId}
      • [POST]pricelist-{priceListId}-update
      • [POST]pricelist-{priceListId}-delete
      • [POST]pricelists-import
      • [POST]pricelists-exceltemplate
      • [POST]pricelists-export
    • SalesEstimate

      • [POST]salesestimates-checkexisting
      • [POST]salesestimates-create
      • [GET]salesestimates
      • [GET]salesestimate-{salesEstimateId}
      • [GET]salesestimate-{salesEstimateId}-currentpricing
      • [POST]salesestimate-{salesEstimateId}-update
      • [POST]salesestimate-{salesEstimateId}-item-{itemId}-update
      • [POST]salesestimate-{salesEstimateId}-item-{itemId}-delete
      • [POST]salesestimate-{salesEstimateId}-release
      • [POST]salesestimate-{salesEstimateId}-newversion
      • [POST]salesestimate-{salesEstimateId}-rollback
      • [POST]salesestimate-{salesEstimateId}-revise
      • [POST]salesestimate-:salesEstimateId-getSalesEstimateDataSheet
      • [POST]salesestimate-{salesEstimateId}-getBillOfMaterials
      • [GET]salesestimate-{salesEstimateId}-refresh
      • [GET]salesestimate-{salesEstimateId}-items
      • [POST]salesestimates-export
    • Shape

      • [GET]shapes
    • Size

      • [GET]hosesizes
      • [GET]endsizes
    • Style

      • [GET]styles
    • User

      • [GET]user
      • [POST]users-update
      • [POST]user-resetpassword
      • [GET]organization-userroles
      • [GET]organization-userrolesandsubscription
      • [GET]organization-roles
      • [POST]organization-users-invite
      • [POST]organization-user-{userId}-delete
      • [POST]organization-user-{userId}-remind
      • [GET]organization-users
    • Warehouse

      • [GET]warehouses
      • [GET]warehouse-{warehouseId}
      • [POST]warehouses-create
      • [POST]warehouse-{warehouseId}-delete
      • [POST]warehouse-{warehouseId}-update
      • [POST]warehouses-export
      • [POST]warehouses-import
      • [POST]warehouses-exceltemplate
      • [GET]organization-defaultwarehouse
    • WorkOrder

      • [POST]workorders-checkexisting
      • [POST]workorders-create
      • [GET]workorders
      • [GET]workorder-{workOrderId}
      • [POST]workorder-{workOrderId}-update
      • [POST]workorder-{workOrderId}-delete
      • [POST]workorder-{workOrderId}-addline
      • [POST]workorder-{workOrderId}-release
      • [POST]workorder-{workOrderId}-newversion
      • [POST]workorder-{workOrderId}-rollback
      • [POST]workorder-{workOrderId}-revise
      • [GET]workorder-{workOrderId}-items
      • [POST]workorder-{workOrderId}-item-{itemId}-delete
      • [POST]workorder-{workOrderId}-item-{itemId}-update
      • [POST]workorder-{workOrderId}-getWorkOrderDataSheet
      • [POST]workorder-{workOrderId}-getmarkenfile
      • [POST]workorder-{workOrderId}-getparkerptsfile
      • [POST]workorders-export
      • [POST]workorder-{workOrderId}-labels
    • Wrap

      • [POST]wraps-create
      • [GET]wrap-{wrapId}
      • [GET]organization-wrapstyles
      • [GET]organization-wrapcoverage
      • [POST]organization-wrap-{wrapId}-update
      • [GET]organization-wraps
      • [GET]organization-customwraps
  • API Schemas

    • Adaptor
    • Brand
    • BrandProperties
    • CrimpFitting
    • Customer
    • CustomerItemProperties
    • Ferrule
    • Hose
    • HoseAssembly
    • HoseKit
    • ImageProperties
    • InventoryItem
    • ItemProperties
    • Item
    • OrganizationCurrency
    • OrganizationOtherItem
    • OrganizationProperties
    • PriceList
    • PriceListItem
    • SalesEstimate
    • Warehouse
    • WorkOrder
    • Wrap

/workorders v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

  • https://goldleaf.app/api/v1

Work Orders

getWorkOrders

Code samples

const headers = {
  Accept: "application/json",
  Authorization: {
    type: "string",
  },
};

fetch("https://goldleaf.app/api/v1/workorders", {
  method: "GET",

  headers: headers,
})
  .then(function (res) {
    return res.json();
  })
  .then(function (body) {
    console.log(body);
  });

GET /workorders

Retrieve all work orders with optional filtering and pagination

Parameters

NameInTypeRequiredDescription
AuthorizationheaderstringtrueBearer token for authorization
search.numberquerystringfalseSearch by work order number (partial or full match)
search.descriptionquerystringfalseSearch by description text
search.statusquerystringfalseSearch by status text
numberquerystringfalseFilter by exact work order number
statusqueryarray[string]falseFilter by one or more statuses
customerOrgIdquerystringfalseFilter by customer organization ID (MongoDB ObjectId)
hoseAssemblyIdquerystringfalseFilter by hose assembly ID (MongoDB ObjectId)
hoseKitIdquerystringfalseFilter by hose kit ID (MongoDB ObjectId)
workOrderIdquerystringfalseFilter by work order ID (MongoDB ObjectId)
salesEstimateIdquerystringfalseFilter by sales estimate ID (MongoDB ObjectId)
onlyCustomerquerybooleanfalseIf true, only include customer-related work orders
pagequeryintegerfalsePage number for pagination (provided by paginationValidators)
limitqueryintegerfalseNumber of items per page (provided by paginationValidators)

Example responses

500 Response

{
  "type": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKList of work orders matching filter criteriaNone
500Internal Server Errornonestring

Response Schema

This operation does not require authentication
Last Updated:: 2025-07-03, 5:53 p.m.
Prev
[POST]workorders-create
Next
[GET]workorder-{workOrderId}