List Work Orders

Required scope: work_order:read

Results are workspace- and authorization-scoped. pageSize defaults to 100 and is capped at 100. Filter by a status string or one portfolio when needed.

Generated Reference

POST /public-api/publicapi.v1.WorkOrder/ListWorkOrders

Lists at most page_size work orders visible to the API key actor. page_size defaults to 100 and may be filtered by status or portfolio.

Request ListWorkOrdersRequest

Response ListWorkOrdersResponse

ListWorkOrdersRequest

Field	Type
`status`	`string`
`page_size`	`int32`
`portfolio_id`	`optional string`

ListWorkOrdersResponse

Field	Type
`work_orders`	`repeated WorkOrder`

Related Types

WorkOrder

Field	Type
`id`	`string`
`portfolio_id`	`string`
`title`	`string`
`description`	`string`
`status`	`string`
`created_at`	`int64`
`updated_at`	`int64`
`portfolio_reference_number`	`string`
`portfolio_title`	`string`
`total_tasks`	`int32`
`completed_tasks`	`int32`
`work_order_template_id`	`optional string`

Request

{
  "status": "open",
  "pageSize": 50,
  "portfolioId": "<portfolio-id>"
}