Cityworks

App · 26 actions

Enter and track service requests, make and update work orders and inspections, add comments and photos, and start workflows when requests and work orders come in, change status or close.

Actions

ActionWhat it does
Add attachmentAttach a file, such as a photo, to a service request, work order or inspection.
Add commentAdd a comment to a service request, work order or inspection.
Cancel service requestCancel a service request entered by mistake or already reported.
Cancel work orderCancel a work order that won't be done.
Close inspectionClose an inspection once it is done.
Close service requestClose a service request once the problem is dealt with.
Close work orderClose a work order once the work is done.
Create inspectionMake an inspection from a template, for an asset or an address, optionally for a service request or a work order.
Create service requestEnter a service request, such as a pothole or a broken streetlight reported by a resident, under a problem code.
Create work orderMake a work order from a template, optionally for assets and linked to service requests.
Create work order from service requestMake a work order for a service request, carrying over its address and linking the two.
Get commentsGet the comments on a service request, work order or inspection, oldest first.
Get inspectionGet an inspection's template, asset, status, findings and dates.
Get service requestGet a service request's problem, status, address, caller and dates.
Get work orderGet a work order's description, status, address, people and dates.
List attachmentsList the files attached to a service request, work order or inspection.
List inspection templatesList the inspection templates inspections can be made from, with their ids.
List problem codesList the problem codes service requests can be entered under, with their ids.
List saved searchesList the searches saved in Cityworks for service requests, work orders and inspections.
List work order templatesList the work order templates, with the kind of asset each is for.
Run saved searchRun a search saved in Cityworks, such as Open potholes this week, and get its results.
Search inspectionsFind inspections by template, status and when they were made.
Search service requestsFind service requests by problem code, status and when they were entered.
Search work ordersFind work orders by template, status and when they were made.
Update service requestChange a service request's status, priority, details, address or resolution.
Update work orderChange a work order's status, priority, people, instructions or dates.

Add attachment

Attach a file, such as a photo, to a service request, work order or inspection. Give a file, or text to attach as a text file.

Inputs

Record typerecord_typetextRequired
Whether the record is a service request, a work order or an inspection.One of: service_request (Service request), work_order (Work order), inspection.
Record numberrecord_idtextRequired
The service request or inspection number, or the work order ID, usually from a trigger or a search.
Filefiletext
The file to attach: upload one or pick one from an earlier step.
Textcontenttext
Text to attach as a text file, when no file is given.
File namefile_nametext
The file's name with its extension, such as photo.jpg.
Commentscommentstext
A note about the file.

Outputs

attachmentobject
An attachment
record_idtext
The record's number
record_typetext
The kind of record
sizenumber
The file's size in bytes
Example output
{
  "attachment": {
    "attached": "2026-10-30T11:05:40",
    "attached_by": "Public Works Clerk",
    "attachment_id": 3391,
    "comments": "Photo from the caller",
    "file_name": "pothole.jpg",
    "title": ""
  },
  "record_id": "104233",
  "record_type": "service_request",
  "size": 48213
}

Add comment

Add a comment to a service request, work order or inspection.

Inputs

Record typerecord_typetextRequired
Whether the record is a service request, a work order or an inspection.One of: service_request (Service request), work_order (Work order), inspection.
Record numberrecord_idtextRequired
The service request or inspection number, or the work order ID, usually from a trigger or a search.
CommentcommenttextRequired
What to say.

Outputs

commentobject
A comment
record_idtext
The record's number
record_typetext
The kind of record
Example output
{
  "comment": {
    "author": "Public Works Clerk",
    "comment": "Crew on site, cones placed.",
    "comment_id": 55120,
    "created": "2026-10-30T11:02:10",
    "last_modified": "2026-10-30T11:02:10"
  },
  "record_id": "26014",
  "record_type": "work_order"
}

Cancel service request

Cancel a service request entered by mistake or already reported.

Inputs

Service request numberrequest_idtextRequired
The service request's number, usually from a trigger or a search.
Reasonreasontext
Why it is being cancelled.

Outputs

service_requestobject
A Cityworks service request
Example output
{
  "service_request": {
    "Cancel": true,
    "DateTimeClosed": null,
    "DateTimeInit": "2026-10-30T09:12:44",
    "Description": "Pothole",
    "Details": "About a foot across, in the eastbound lane",
    "DispatchTo": "Streets Crew 2",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "OtherSystemId": "311-88213",
    "Priority": "2",
    "ProbAddress": "120 MAIN ST",
    "ProblemCode": "POTHOLE",
    "ProblemSid": 2156,
    "RequestId": 104233,
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "WorkOrderId": ""
  }
}

Cancel work order

Cancel a work order that won't be done.

Inputs

Work order IDwork_order_idtextRequired
The work order's ID, usually from a trigger or a search.
Reasonreasontext
Why it is being cancelled.

Outputs

work_orderobject
A Cityworks work order
Example output
{
  "work_order": {
    "ActualFinishDate": null,
    "ActualStartDate": null,
    "ApplyToEntity": "STREET",
    "Cancel": true,
    "DateWOClosed": null,
    "Description": "Repair pothole",
    "InitiateDate": "2026-10-30T09:20:03",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "Location": "Eastbound lane near the library",
    "Priority": "2",
    "ProjFinishDate": null,
    "ProjStartDate": "2026-11-02T08:00:00",
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "Supervisor": "Pat Moreno",
    "WOAddress": "120 MAIN ST",
    "WOTemplateId": "201",
    "WorkOrderId": "26014",
    "WorkOrderSid": 26014
  }
}

Close inspection

Close an inspection once it is done.

Inputs

Inspection numberinspection_idtextRequired
The inspection's number, usually from a trigger or a search.

Outputs

inspectionobject
A Cityworks inspection
Example output
{
  "inspection": {
    "DateClosed": null,
    "EntityType": "HYDRANT",
    "EntityUid": "HYD-00412",
    "InitiateDate": "2026-10-30T10:01:00",
    "InitiatedBy": "Public Works Clerk",
    "InspDate": null,
    "InspTemplateId": 12,
    "InspTemplateName": "Hydrant Inspection",
    "InspectedBy": "",
    "InspectionId": 8812,
    "IsClosed": true,
    "Location": "Corner of Main St and 2nd Ave",
    "ObservationSum": "",
    "Priority": "3",
    "RepairsMade": "",
    "RequestId": null,
    "Status": "CLOSED",
    "StreetName": "MAIN ST",
    "WorkOrderId": ""
  }
}

Close service request

Close a service request once the problem is dealt with.

Inputs

Service request numberrequest_idtextRequired
The service request's number, usually from a trigger or a search.

Outputs

service_requestobject
A Cityworks service request
Example output
{
  "service_request": {
    "Cancel": false,
    "DateTimeClosed": null,
    "DateTimeInit": "2026-10-30T09:12:44",
    "Description": "Pothole",
    "Details": "About a foot across, in the eastbound lane",
    "DispatchTo": "Streets Crew 2",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": true,
    "OtherSystemId": "311-88213",
    "Priority": "2",
    "ProbAddress": "120 MAIN ST",
    "ProblemCode": "POTHOLE",
    "ProblemSid": 2156,
    "RequestId": 104233,
    "Status": "CLOSED",
    "SubmitTo": "Dana Ruiz",
    "WorkOrderId": ""
  }
}

Close work order

Close a work order once the work is done.

Inputs

Work order IDwork_order_idtextRequired
The work order's ID, usually from a trigger or a search.

Outputs

work_orderobject
A Cityworks work order
Example output
{
  "work_order": {
    "ActualFinishDate": null,
    "ActualStartDate": null,
    "ApplyToEntity": "STREET",
    "Cancel": false,
    "DateWOClosed": null,
    "Description": "Repair pothole",
    "InitiateDate": "2026-10-30T09:20:03",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": true,
    "Location": "Eastbound lane near the library",
    "Priority": "2",
    "ProjFinishDate": null,
    "ProjStartDate": "2026-11-02T08:00:00",
    "Status": "CLOSED",
    "SubmitTo": "Dana Ruiz",
    "Supervisor": "Pat Moreno",
    "WOAddress": "120 MAIN ST",
    "WOTemplateId": "201",
    "WorkOrderId": "26014",
    "WorkOrderSid": 26014
  }
}

Create inspection

Make an inspection from a template, for an asset or an address, optionally for a service request or a work order.

Inputs

Inspection templatetemplate_idtextRequired
The kind of inspection, as set up in Cityworks.
Kind of assetentity_typetext
The kind of asset to inspect. Leave empty for the template's first.
Asset IDasset_idtext
The asset to inspect, by its asset ID, such as HYD-00412.
Addressaddresstext
Where the inspection is, when it isn't for a request or work order.
Commentscommentstext
A first comment on the inspection.
Submit tosubmit_totext
Who the inspection goes to.
Inspect byprojected_startdate and time
When the inspection should start.
Service request numberrequest_idtext
Make it for this service request. Leave empty otherwise.
Work order IDwork_order_idtext
Make it for this work order. Leave empty otherwise.

Outputs

inspectionobject
A Cityworks inspection
inspection_idnumber
The new inspection's number
Example output
{
  "inspection": {
    "DateClosed": null,
    "EntityType": "HYDRANT",
    "EntityUid": "HYD-00412",
    "InitiateDate": "2026-10-30T10:01:00",
    "InitiatedBy": "Public Works Clerk",
    "InspDate": null,
    "InspTemplateId": 12,
    "InspTemplateName": "Hydrant Inspection",
    "InspectedBy": "",
    "InspectionId": 8812,
    "IsClosed": false,
    "Location": "Corner of Main St and 2nd Ave",
    "ObservationSum": "",
    "Priority": "3",
    "RepairsMade": "",
    "RequestId": null,
    "Status": "OPEN",
    "StreetName": "MAIN ST",
    "WorkOrderId": ""
  },
  "inspection_id": 8812
}

Create service request

Enter a service request, such as a pothole or a broken streetlight reported by a resident, under a problem code.

Inputs

Problem codeproblem_sidtextRequired
What the problem is, as set up in Cityworks.
Addressaddresstext
Where the problem is, such as 120 Main St.
Detailsdetailstext
Details about the problem.
Commentscommentstext
A first comment on the request.
Priorityprioritytext
The request's priority. Pick a problem code first.
Caller first namecaller_first_nametext
The caller's first name.
Caller last namecaller_last_nametext
The caller's last name.
Caller emailcaller_emailtext
The caller's email address.
Caller phonecaller_phonetext
The caller's phone number.
Caller addresscaller_addresstext
The caller's own address.
Caller commentscaller_commentstext
What the caller said, in their words.
Reference numberother_system_idtext
The request's number in another system, such as a 311 case number.
Place on the mapplace_on_maptrue/false
Have Cityworks find the address and place the record on its map.Default: false.

Outputs

request_idnumber
The new service request's number
service_requestobject
A Cityworks service request
Example output
{
  "request_id": 104233,
  "service_request": {
    "Cancel": false,
    "DateTimeClosed": null,
    "DateTimeInit": "2026-10-30T09:12:44",
    "Description": "Pothole",
    "Details": "About a foot across, in the eastbound lane",
    "DispatchTo": "Streets Crew 2",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "OtherSystemId": "311-88213",
    "Priority": "2",
    "ProbAddress": "120 MAIN ST",
    "ProblemCode": "POTHOLE",
    "ProblemSid": 2156,
    "RequestId": 104233,
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "WorkOrderId": ""
  }
}

Create work order

Make a work order from a template, optionally for assets and linked to service requests.

Inputs

Work order templatetemplate_idtextRequired
The kind of work, as set up in Cityworks. It also sets the kind of asset.
Addressaddresstext
Where the work is, such as 120 Main St.
Locationlocationtext
A description of where, such as Eastbound lane.
Instructionsinstructionstext
Instructions for the crew.
Commentscommentstext
A first comment on the work order.
Priorityprioritytext
The work order's priority.
Submit tosubmit_totext
Who the work order goes to.
Supervisorsupervisortext
The work order's supervisor.
Start byprojected_startdate and time
When the work should start.
Asset IDsasset_idslist
The assets to work on, by their asset IDs as on the map, such as HYD-00412. They must be of the template's kind of asset.
Service request numbersrequest_idslist
Service requests to link the work order to.
Place on the mapplace_on_maptrue/false
Have Cityworks find the address and place the record on its map.Default: false.

Outputs

work_orderobject
A Cityworks work order
work_order_idtext
The new work order's ID
Example output
{
  "work_order": {
    "ActualFinishDate": null,
    "ActualStartDate": null,
    "ApplyToEntity": "STREET",
    "Cancel": false,
    "DateWOClosed": null,
    "Description": "Repair pothole",
    "InitiateDate": "2026-10-30T09:20:03",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "Location": "Eastbound lane near the library",
    "Priority": "2",
    "ProjFinishDate": null,
    "ProjStartDate": "2026-11-02T08:00:00",
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "Supervisor": "Pat Moreno",
    "WOAddress": "120 MAIN ST",
    "WOTemplateId": "201",
    "WorkOrderId": "26014",
    "WorkOrderSid": 26014
  },
  "work_order_id": "26014"
}

Create work order from service request

Make a work order for a service request, carrying over its address and linking the two.

Inputs

Service request numberrequest_idtextRequired
The service request's number, usually from a trigger or a search.
Work order templatetemplate_idtextRequired
The kind of work, as set up in Cityworks. It also sets the kind of asset.
Instructionsinstructionstext
Instructions for the crew.
Commentscommentstext
A first comment on the work order.
Priorityprioritytext
The work order's priority.
Submit tosubmit_totext
Who the work order goes to.
Supervisorsupervisortext
The work order's supervisor.
Start byprojected_startdate and time
When the work should start.

Outputs

request_idnumber
The service request it was made for
work_orderobject
A Cityworks work order
work_order_idtext
The new work order's ID
Example output
{
  "request_id": 104233,
  "work_order": {
    "ActualFinishDate": null,
    "ActualStartDate": null,
    "ApplyToEntity": "STREET",
    "Cancel": false,
    "DateWOClosed": null,
    "Description": "Repair pothole",
    "InitiateDate": "2026-10-30T09:20:03",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "Location": "Eastbound lane near the library",
    "Priority": "2",
    "ProjFinishDate": null,
    "ProjStartDate": "2026-11-02T08:00:00",
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "Supervisor": "Pat Moreno",
    "WOAddress": "120 MAIN ST",
    "WOTemplateId": "201",
    "WorkOrderId": "26014",
    "WorkOrderSid": 26014
  },
  "work_order_id": "26014"
}

Get comments

Get the comments on a service request, work order or inspection, oldest first.

Inputs

Record typerecord_typetextRequired
Whether the record is a service request, a work order or an inspection.One of: service_request (Service request), work_order (Work order), inspection.
Record numberrecord_idtextRequired
The service request or inspection number, or the work order ID, usually from a trigger or a search.

Outputs

commentslist
The comments
countnumber
How many there are
record_idtext
The record's number
record_typetext
The kind of record
Example output
{
  "comments": [
    {
      "author": "Public Works Clerk",
      "comment": "Crew on site, cones placed.",
      "comment_id": 55120,
      "created": "2026-10-30T11:02:10",
      "last_modified": "2026-10-30T11:02:10"
    }
  ],
  "count": 1,
  "record_id": "26014",
  "record_type": "work_order"
}

Get inspection

Get an inspection's template, asset, status, findings and dates.

Inputs

Inspection numberinspection_idtextRequired
The inspection's number, usually from a trigger or a search.

Outputs

inspectionobject
A Cityworks inspection
Example output
{
  "inspection": {
    "DateClosed": null,
    "EntityType": "HYDRANT",
    "EntityUid": "HYD-00412",
    "InitiateDate": "2026-10-30T10:01:00",
    "InitiatedBy": "Public Works Clerk",
    "InspDate": null,
    "InspTemplateId": 12,
    "InspTemplateName": "Hydrant Inspection",
    "InspectedBy": "",
    "InspectionId": 8812,
    "IsClosed": false,
    "Location": "Corner of Main St and 2nd Ave",
    "ObservationSum": "",
    "Priority": "3",
    "RepairsMade": "",
    "RequestId": null,
    "Status": "OPEN",
    "StreetName": "MAIN ST",
    "WorkOrderId": ""
  }
}

Get service request

Get a service request's problem, status, address, caller and dates.

Inputs

Service request numberrequest_idtextRequired
The service request's number, usually from a trigger or a search.

Outputs

service_requestobject
A Cityworks service request
Example output
{
  "service_request": {
    "Cancel": false,
    "DateTimeClosed": null,
    "DateTimeInit": "2026-10-30T09:12:44",
    "Description": "Pothole",
    "Details": "About a foot across, in the eastbound lane",
    "DispatchTo": "Streets Crew 2",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "OtherSystemId": "311-88213",
    "Priority": "2",
    "ProbAddress": "120 MAIN ST",
    "ProblemCode": "POTHOLE",
    "ProblemSid": 2156,
    "RequestId": 104233,
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "WorkOrderId": ""
  }
}

Get work order

Get a work order's description, status, address, people and dates.

Inputs

Work order IDwork_order_idtextRequired
The work order's ID, usually from a trigger or a search.

Outputs

work_orderobject
A Cityworks work order
Example output
{
  "work_order": {
    "ActualFinishDate": null,
    "ActualStartDate": null,
    "ApplyToEntity": "STREET",
    "Cancel": false,
    "DateWOClosed": null,
    "Description": "Repair pothole",
    "InitiateDate": "2026-10-30T09:20:03",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "Location": "Eastbound lane near the library",
    "Priority": "2",
    "ProjFinishDate": null,
    "ProjStartDate": "2026-11-02T08:00:00",
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "Supervisor": "Pat Moreno",
    "WOAddress": "120 MAIN ST",
    "WOTemplateId": "201",
    "WorkOrderId": "26014",
    "WorkOrderSid": 26014
  }
}

List attachments

List the files attached to a service request, work order or inspection.

Inputs

Record typerecord_typetextRequired
Whether the record is a service request, a work order or an inspection.One of: service_request (Service request), work_order (Work order), inspection.
Record numberrecord_idtextRequired
The service request or inspection number, or the work order ID, usually from a trigger or a search.

Outputs

attachmentslist
The attachments
countnumber
How many there are
record_idtext
The record's number
record_typetext
The kind of record
Example output
{
  "attachments": [
    {
      "attached": "2026-10-30T11:05:40",
      "attached_by": "Public Works Clerk",
      "attachment_id": 3391,
      "comments": "Photo from the caller",
      "file_name": "pothole.jpg",
      "title": ""
    }
  ],
  "count": 1,
  "record_id": "104233",
  "record_type": "service_request"
}

List inspection templates

List the inspection templates inspections can be made from, with their ids.

Inputs

None.

Outputs

countnumber
How many there are
templateslist
The templates
Example output
{
  "count": 1,
  "templates": [
    {
      "description": "Yearly hydrant flow and condition check",
      "name": "Hydrant Inspection",
      "priority": "3",
      "template_id": 12
    }
  ]
}

List problem codes

List the problem codes service requests can be entered under, with their ids.

Inputs

None.

Outputs

countnumber
How many there are
problem_codeslist
The problem codes
Example output
{
  "count": 1,
  "problem_codes": [
    {
      "description": "Pothole",
      "domain_id": 1,
      "problem_code": "POTHOLE",
      "problem_sid": 2156
    }
  ]
}

List saved searches

List the searches saved in Cityworks for service requests, work orders and inspections.

Inputs

None.

Outputs

countnumber
How many there are
saved_searcheslist
The saved searches
Example output
{
  "count": 1,
  "saved_searches": [
    {
      "kind": "Service requests",
      "name": "Open potholes this week",
      "search_id": 431
    }
  ]
}

List work order templates

List the work order templates, with the kind of asset each is for.

Inputs

None.

Outputs

countnumber
How many there are
templateslist
The templates
Example output
{
  "count": 1,
  "templates": [
    {
      "category": "STREETS",
      "description": "Repair pothole",
      "entity_type": "STREET",
      "priority": "2",
      "template_id": "201"
    }
  ]
}

Run a search saved in Cityworks, such as Open potholes this week, and get its results.

Inputs

Saved searchsearch_idtextRequired
The saved search to run.
Most resultsmax_resultsnumber
How many records to return at most, 1 to 500. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many there are
resultslist
The results
search_idnumber
The saved search
Example output
{
  "count": 1,
  "results": [
    {
      "Description": "Pothole",
      "RequestId": 104233,
      "Status": "OPEN"
    }
  ],
  "search_id": 431
}

Search inspections

Find inspections by template, status and when they were made.

Inputs

Inspection templatetemplate_idtext
Only inspections made from this template.
Statusstatustext
Only inspections with this status.
Open or closedstatetext
Only open, closed or cancelled records. Defaults to any.One of: open, closed, cancelled, any. Default: any.
Made on or aftercreated_afterdate
Only inspections made on or after this day.
Made on or beforecreated_beforedate
Only inspections made on or before this day.
Most resultsmax_resultsnumber
How many records to return at most, 1 to 500. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many there are
inspectionslist
The matching inspections, newest first
Example output
{
  "count": 1,
  "inspections": [
    {
      "DateClosed": null,
      "EntityType": "HYDRANT",
      "EntityUid": "HYD-00412",
      "InitiateDate": "2026-10-30T10:01:00",
      "InitiatedBy": "Public Works Clerk",
      "InspDate": null,
      "InspTemplateId": 12,
      "InspTemplateName": "Hydrant Inspection",
      "InspectedBy": "",
      "InspectionId": 8812,
      "IsClosed": false,
      "Location": "Corner of Main St and 2nd Ave",
      "ObservationSum": "",
      "Priority": "3",
      "RepairsMade": "",
      "RequestId": null,
      "Status": "OPEN",
      "StreetName": "MAIN ST",
      "WorkOrderId": ""
    }
  ]
}

Search service requests

Find service requests by problem code, status and when they were entered.

Inputs

Problem codeproblem_sidtext
Only requests with this problem code.
Statusstatustext
Only requests with this status.
Open or closedstatetext
Only open, closed or cancelled records. Defaults to any.One of: open, closed, cancelled, any. Default: any.
Entered on or aftercreated_afterdate
Only records entered on or after this day.
Entered on or beforecreated_beforedate
Only records entered on or before this day.
Reference numberother_system_idtext
Only the request with this number from another system.
Most resultsmax_resultsnumber
How many records to return at most, 1 to 500. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many there are
service_requestslist
The matching requests, newest first
Example output
{
  "count": 1,
  "service_requests": [
    {
      "Cancel": false,
      "DateTimeClosed": null,
      "DateTimeInit": "2026-10-30T09:12:44",
      "Description": "Pothole",
      "Details": "About a foot across, in the eastbound lane",
      "DispatchTo": "Streets Crew 2",
      "InitiatedBy": "Public Works Clerk",
      "IsClosed": false,
      "OtherSystemId": "311-88213",
      "Priority": "2",
      "ProbAddress": "120 MAIN ST",
      "ProblemCode": "POTHOLE",
      "ProblemSid": 2156,
      "RequestId": 104233,
      "Status": "OPEN",
      "SubmitTo": "Dana Ruiz",
      "WorkOrderId": ""
    }
  ]
}

Search work orders

Find work orders by template, status and when they were made.

Inputs

Work order templatetemplate_idtext
Only work orders made from this template.
Statusstatustext
Only work orders with this status.
Open or closedstatetext
Only open, closed or cancelled records. Defaults to any.One of: open, closed, cancelled, any. Default: any.
Made on or aftercreated_afterdate
Only work orders made on or after this day.
Made on or beforecreated_beforedate
Only work orders made on or before this day.
Most resultsmax_resultsnumber
How many records to return at most, 1 to 500. Defaults to 100.From 1 to 500.

Outputs

countnumber
How many there are
work_orderslist
The matching work orders, newest first
Example output
{
  "count": 1,
  "work_orders": [
    {
      "ActualFinishDate": null,
      "ActualStartDate": null,
      "ApplyToEntity": "STREET",
      "Cancel": false,
      "DateWOClosed": null,
      "Description": "Repair pothole",
      "InitiateDate": "2026-10-30T09:20:03",
      "InitiatedBy": "Public Works Clerk",
      "IsClosed": false,
      "Location": "Eastbound lane near the library",
      "Priority": "2",
      "ProjFinishDate": null,
      "ProjStartDate": "2026-11-02T08:00:00",
      "Status": "OPEN",
      "SubmitTo": "Dana Ruiz",
      "Supervisor": "Pat Moreno",
      "WOAddress": "120 MAIN ST",
      "WOTemplateId": "201",
      "WorkOrderId": "26014",
      "WorkOrderSid": 26014
    }
  ]
}

Update service request

Change a service request's status, priority, details, address or resolution.

Inputs

Service request numberrequest_idtextRequired
The service request's number, usually from a trigger or a search.
Statusstatustext
The new status.
Priorityprioritytext
The new priority, such as 2.
Detailsdetailstext
New details about the problem.
Addressaddresstext
The corrected address of the problem.
Resolutionresolutiontext
How the problem was resolved.
Reference numberother_system_idtext
The request's number in another system.

Outputs

service_requestobject
A Cityworks service request
Example output
{
  "service_request": {
    "Cancel": false,
    "DateTimeClosed": null,
    "DateTimeInit": "2026-10-30T09:12:44",
    "Description": "Pothole",
    "Details": "About a foot across, in the eastbound lane",
    "DispatchTo": "Streets Crew 2",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "OtherSystemId": "311-88213",
    "Priority": "2",
    "ProbAddress": "120 MAIN ST",
    "ProblemCode": "POTHOLE",
    "ProblemSid": 2156,
    "RequestId": 104233,
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "WorkOrderId": ""
  }
}

Update work order

Change a work order's status, priority, people, instructions or dates.

Inputs

Work order IDwork_order_idtextRequired
The work order's ID, usually from a trigger or a search.
Statusstatustext
The new status.
Priorityprioritytext
The work order's priority.
Instructionsinstructionstext
Instructions for the crew.
Descriptiondescriptiontext
A new description of the work.
Addressaddresstext
The corrected address of the work.
Submit tosubmit_totext
Who the work order goes to.
Supervisorsupervisortext
The work order's supervisor.
Start byprojected_startdate and time
When the work should start.
Finish byprojected_finishdate and time
When the work should finish.
Startedactual_startdate and time
When the work started.
Finishedactual_finishdate and time
When the work finished.
Resolutionresolutiontext
How the work was resolved.

Outputs

work_orderobject
A Cityworks work order
Example output
{
  "work_order": {
    "ActualFinishDate": null,
    "ActualStartDate": null,
    "ApplyToEntity": "STREET",
    "Cancel": false,
    "DateWOClosed": null,
    "Description": "Repair pothole",
    "InitiateDate": "2026-10-30T09:20:03",
    "InitiatedBy": "Public Works Clerk",
    "IsClosed": false,
    "Location": "Eastbound lane near the library",
    "Priority": "2",
    "ProjFinishDate": null,
    "ProjStartDate": "2026-11-02T08:00:00",
    "Status": "OPEN",
    "SubmitTo": "Dana Ruiz",
    "Supervisor": "Pat Moreno",
    "WOAddress": "120 MAIN ST",
    "WOTemplateId": "201",
    "WorkOrderId": "26014",
    "WorkOrderSid": 26014
  }
}

On this page