GET api/v1/WorkOrders?Search={Search}&Limit={Limit}&StatusID={StatusID}

Gather a list of work orders.

Request Information

URI Parameters

Name	Description	Type	Additional information
Search	Filter returned results	string	Default value is
Limit	Amount of results returned	integer	Default value is 100
StatusID	Status of the work order	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

A list of work orders

IBMS_Cloud_API.WorkOrdersModel+WorkOrder

Name	Description	Type	Additional information
WorkOrderID	Unique identifier for a work order	integer	None.
Reference	Work order reference	string	None.
OrderNumber	Customer order number	string	None.
Description	Description of a work order	string	None.
WODetails	Work order details	string	None.
SiteName	Associated Site name	string	None.
SiteID	Associated Site ID	integer	None.
ClientName	Associated Client name	string	None.
ClientID	Associated Client ID	integer	None.
WODate	When the work order was created	date	None.
Status	Current status of the work order	string	None.
WOManager	Employee who is managing the work order	string	None.
QuotedPrice	Quoted price of the work order	string	None.
StatusID	Current Status ID of the work order	integer	None.
TypeID	Type of work order	integer	None.
NextAppointment	Details of next appointment	string	None.
AppointmentCount		string	None.
Category		string	None.
WODetailsTooltip		string	None.
InvoiceStatus		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "WorkOrderID": 1,
  "Reference": "sample string 2",
  "OrderNumber": "sample string 3",
  "Description": "sample string 4",
  "WODetails": "sample string 5",
  "SiteName": "sample string 6",
  "SiteID": 7,
  "ClientName": "sample string 8",
  "ClientID": 9,
  "WODate": "2025-04-28T15:20:21.8000592+01:00",
  "Status": "sample string 11",
  "WOManager": "sample string 12",
  "QuotedPrice": "sample string 13",
  "StatusID": 14,
  "TypeID": 15,
  "NextAppointment": "sample string 16",
  "AppointmentCount": "sample string 17",
  "Category": "sample string 18",
  "WODetailsTooltip": "sample string 19",
  "InvoiceStatus": 20
}

text/html

Sample:

{"WorkOrderID":1,"Reference":"sample string 2","OrderNumber":"sample string 3","Description":"sample string 4","WODetails":"sample string 5","SiteName":"sample string 6","SiteID":7,"ClientName":"sample string 8","ClientID":9,"WODate":"2025-04-28T15:20:21.8000592+01:00","Status":"sample string 11","WOManager":"sample string 12","QuotedPrice":"sample string 13","StatusID":14,"TypeID":15,"NextAppointment":"sample string 16","AppointmentCount":"sample string 17","Category":"sample string 18","WODetailsTooltip":"sample string 19","InvoiceStatus":20}

application/xml, text/xml

Sample:

<WorkOrdersModel.WorkOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <AppointmentCount>sample string 17</AppointmentCount>
  <Category>sample string 18</Category>
  <ClientID>9</ClientID>
  <ClientName>sample string 8</ClientName>
  <Description>sample string 4</Description>
  <InvoiceStatus>20</InvoiceStatus>
  <NextAppointment>sample string 16</NextAppointment>
  <OrderNumber>sample string 3</OrderNumber>
  <QuotedPrice>sample string 13</QuotedPrice>
  <Reference>sample string 2</Reference>
  <SiteID>7</SiteID>
  <SiteName>sample string 6</SiteName>
  <Status>sample string 11</Status>
  <StatusID>14</StatusID>
  <TypeID>15</TypeID>
  <WODate>2025-04-28T15:20:21.8000592+01:00</WODate>
  <WODetails>sample string 5</WODetails>
  <WODetailsTooltip>sample string 19</WODetailsTooltip>
  <WOManager>sample string 12</WOManager>
  <WorkOrderID>1</WorkOrderID>
</WorkOrdersModel.WorkOrder>