---
title: "Finds change orders based on search parameters. Rows carry the change order header without its impacted records; read one change order to get those. Sorts on `number`, `status`, `requestedUtc`, `approvedUtc`, `completedUtc`, `dueDateUtc`, `createdUtc`, `modifiedUtc`, `customer`, `disposition` or `detail`; an unrecognised sort field falls back to `requestedUtc` ascending."
method: POST
path: "/api/change-orders/list"
tags: ["Change Order"]
---

# Finds change orders based on search parameters. Rows carry the change order header without its impacted records; read one change order to get those. Sorts on \`number\`, \`status\`, \`requestedUtc\`, \`approvedUtc\`, \`completedUtc\`, \`dueDateUtc\`, \`createdUtc\`, \`modifiedUtc\`, \`customer\`, \`disposition\` or \`detail\`; an unrecognised sort field falls back to \`requestedUtc\` ascending.

`POST /api/change-orders/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- ChangeOrdersListParameters — Filters for the change order list. All filters are optional and combine with AND semantics (list-valued filters match any of their values).
  - `search` string, nullable — Case-insensitive search over the customer name, the original and new revision items, and the detail
  - `statuses` ChangeOrderStatusEnum[], nullable — Only change orders in these statuses
  - `customerIds` string[], nullable — Only change orders raised for these customers
  - `dispositionIds` string[], nullable — Only change orders carrying these dispositions
  - `requestedFromUtc` string, date-time, nullable — Inclusive lower bound on requestedUtc
  - `requestedToUtc` string, date-time, nullable — Inclusive upper bound on requestedUtc
  - `dueFromUtc` string, date-time, nullable — Inclusive lower bound on dueDateUtc
  - `dueToUtc` string, date-time, nullable — Inclusive upper bound on dueDateUtc
  - `createdFromUtc` string, date-time, nullable — Inclusive lower bound on createdUtc
  - `createdToUtc` string, date-time, nullable — Inclusive upper bound on createdUtc
  - `completedFromUtc` string, date-time, nullable — Inclusive lower bound on completedUtc
  - `completedToUtc` string, date-time, nullable — Inclusive upper bound on completedUtc
  - `overdue` boolean, nullable — True narrows to change orders whose due date has passed and that are not Completed. False and omitted both apply no clause — this narrows, it does not select the complement
  - `impactedDocumentId` string, nullable — Only change orders impacting this sales order, job or quote
  - `revisionItemId` string, nullable — Only change orders whose original or new revision item is this item
  - `modifiedAfterUtc` string, date-time, nullable — Only change orders written strictly after this UTC instant. Poll with the largest modifiedUtc you hold to pick up creates and edits; deletions do not advance modifiedUtc
  - `modifiedBeforeUtc` string, date-time, nullable — Only change orders written at or before this UTC instant

## Response `200`

The matching change orders

- DtoPagedResultDtoChangeOrderSummaryDto — Paged result
  - `data` ChangeOrderSummaryDto[], required — The data
    - `id` string, nullable — The id of the change order
    - `number` integer — The change order's sequential number, unique within the tenant and assigned server-side
    - `customer` CommonReferenceDto — Represents a reference to a document in a DB collection
      - `id` string, nullable — Unique Id associated to the referenced object
      - `name` string, nullable — Descriptive name associated to the object
    - `originalRevisionItem` ChangeOrderItemReferenceDto — A reference to an item revision on a change order.
      - `id` string, nullable — The id of the item revision, as returned by Item List
      - `name` string, nullable — The item's number and revision together, as the app displays it. Read-only
      - `number` string, nullable — The item's number. Read-only
      - `revision` string, nullable — The item's revision, or null when the item carries none. Read-only
    - `newRevisionItem` ChangeOrderItemReferenceDto — A reference to an item revision on a change order.
      - `id` string, nullable — The id of the item revision, as returned by Item List
      - `name` string, nullable — The item's number and revision together, as the app displays it. Read-only
      - `number` string, nullable — The item's number. Read-only
      - `revision` string, nullable — The item's revision, or null when the item carries none. Read-only
    - `requestedUtc` string, date-time, nullable — When the change was requested (UTC). Defaults to the moment of creation when not supplied
    - `dueDateUtc` string, date-time, nullable — When the change order is due (UTC), or null when it carries no date
    - `approvedUtc` string, date-time, nullable — When the change order was approved (UTC), or null when it has not been
    - `completedUtc` string, date-time, nullable — When the change order was completed (UTC). Stamped server-side when status moves to Completed without one supplied
    - `status` 'new' | 'inProgress' | 'completed' — Where a change order stands.
    - `detail` string, nullable — What the change is
    - `disposition` CommonReferenceDto — Represents a reference to a document in a DB collection
      - `id` string, nullable — Unique Id associated to the referenced object
      - `name` string, nullable — Descriptive name associated to the object
    - `notificationsEnabled` boolean, nullable — Whether completing a task on this change order tells the owners of the next step
    - `createdBy` CommonReferenceDto — Represents a reference to a document in a DB collection
      - `id` string, nullable — Unique Id associated to the referenced object
      - `name` string, nullable — Descriptive name associated to the object
    - `createdUtc` string, date-time, nullable — When the change order was created (UTC). Read-only
    - `modifiedBy` CommonReferenceDto — Represents a reference to a document in a DB collection
      - `id` string, nullable — Unique Id associated to the referenced object
      - `name` string, nullable — Descriptive name associated to the object
    - `modifiedUtc` string, date-time, nullable — When the change order was last modified (UTC); supports incremental sync. Read-only
  - `page` integer, required — The 1-indexed page
  - `pageSize` integer, required — The page size
  - `totalCount` integer, required — The total count of records
  - `totalPages` integer, required — The total pages
  - `hasPreviousPage` boolean, required — True if there is a previous page
  - `hasNextPage` boolean, required — True if there is a next page

## Other responses

- `400` — Validation issues with input

## Changes

- **2026-09-26** `e584a13d530a` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/fulcrumpro/apis/fulcrum-publicapi/changes/api/change-orders/list/post.md)

---

[API](https://skmtc.dev/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.dev/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc.dev/fulcrumpro/apis/fulcrum-publicapi/revisions/e584a13d530a?raw)