Skip to main content
GET
Count work orders

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Query Parameters

Full-text search. Matches words (with prefix and stem matching) across the title, description, location name, notes, service call check-in/check-out notes, problem type name, and reference numbers (work order number, PO number, asset serial number). Wrap the value in double quotes to require the exact phrase.

id
integer

One work order by id, or several in one call (ids=9001,9002). Useful for refreshing a known batch. One value. To match several, use the plural key.

ids
string

One work order by id, or several in one call (ids=9001,9002). Useful for refreshing a known batch. Comma-separated list; matches any value listed.

status
string

The detailed workflow status, for example statuses=WaitingForReview to find work ready for your review. Values are listed in the status model. One value. To match several, use the plural key.

statuses
string

The detailed workflow status, for example statuses=WaitingForReview to find work ready for your review. Values are listed in the status model. Comma-separated list; matches any value listed.

notStatuses
string

The detailed workflow status, for example statuses=WaitingForReview to find work ready for your review. Values are listed in the status model. Comma-separated list; excludes every value listed.

displayStatus
string

The simplified status shown in the OpenWrench app: Pending, Deferred, Open, InProgress, OnHold, Completed, or Cancelled. Every detailed status maps to one of these. One value. To match several, use the plural key.

displayStatuses
string

The simplified status shown in the OpenWrench app: Pending, Deferred, Open, InProgress, OnHold, Completed, or Cancelled. Every detailed status maps to one of these. Comma-separated list; matches any value listed.

isActive
enum<string>

true returns work still in progress (display status Pending, Open, InProgress, or OnHold). false returns closed work (Completed or Cancelled). Deferred work orders match neither value. Archived work orders are included either way; add hasBuyerArchived=false to leave them out.

Available options:
true,
false
hasBuyerArchived
enum<string>

false leaves out work orders your team has archived; true returns only archived ones. Archiving is separate from status, so open work can be archived too.

Available options:
true,
false
locationId
integer

Work at these locations. Get location ids from GET /v1/buyer/location/locations. One value. To match several, use the plural key.

locationIds
string

Work at these locations. Get location ids from GET /v1/buyer/location/locations. Comma-separated list; matches any value listed.

assetId
integer

Work on these assets, whether as the main asset or a sub-asset. Get asset ids from GET /v1/buyer/asset/assets. One value. To match several, use the plural key.

assetIds
string

Work on these assets, whether as the main asset or a sub-asset. Get asset ids from GET /v1/buyer/asset/assets. Comma-separated list; matches any value listed.

problemTypeId
integer

Work of these problem types. Get ids from GET /v1/buyer/work_order/problem_types. One value. To match several, use the plural key.

problemTypeIds
string

Work of these problem types. Get ids from GET /v1/buyer/work_order/problem_types. Comma-separated list; matches any value listed.

woPriorityId
integer

Work at these priorities. Priority ids are your company's own; each work order shows its priority in woPriorityId. One value. To match several, use the plural key.

woPriorityIds
string

Work at these priorities. Priority ids are your company's own; each work order shows its priority in woPriorityId. Comma-separated list; matches any value listed.

labelIds
string

Work carrying at least one of these labels. Get label ids from the label catalog. Comma-separated list; matches any value listed.

isPM
enum<string>

true returns only preventive maintenance work generated from a PM schedule; false leaves it out.

Available options:
true,
false
createdAtStartDate
string

Earliest creation time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

createdAtEndDate
string

Latest creation time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive and exact, so send 23:59:59 to include the whole end day. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

completedAtStartDate
string

Earliest completion time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

completedAtEndDate
string

Latest completion time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive and exact, so send 23:59:59 to include the whole end day. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

lastServiceCallServiceScheduledAtStartDate
string

Earliest scheduled time of the most recent visit to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

lastServiceCallServiceScheduledAtEndDate
string

Latest scheduled time of the most recent visit to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive and exact, so send 23:59:59 to include the whole end day. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

pastDue
enum<string>

true returns open work whose due date has passed; false returns open work that is not yet due. Closed work (Completed or Cancelled) and work with no due date match neither value.

Available options:
true,
false
pastSchedule
enum<string>

Like pastDue, on the scheduled visit date: true returns open work whose scheduled date has passed.

Available options:
true,
false
pastEstimatedCompletion
enum<string>

Like pastDue, on the supplier's estimated completion date. When no estimate has been given, the due date is used.

Available options:
true,
false
unscheduledOrPastSchedule
enum<string>

true returns work with no scheduled date, or whose scheduled date has passed: work that needs scheduling attention. Closed work is included, so add isActive=true to see only open work.

Available options:
true,
false
buyerProjectId
integer

Work in one project. A work order lists its projects in buyerProjectIds. One value.

siteSurveyTaskTitleId
string

Follow-up work created from one walkthrough task: the siteSurveyTaskTitleId you sent when creating the work order. One value.

supplierFacilityId
integer

Work assigned to these suppliers. Get supplier facility ids from GET /v1/buyer/supplier_facilities. One value. To match several, use the plural key.

supplierFacilityIds
string

Work assigned to these suppliers. Get supplier facility ids from GET /v1/buyer/supplier_facilities. Comma-separated list; matches any value listed.

isStale
enum<string>

true returns open work that has stayed overdue for a set period without supplier progress, and that your team hasn't archived. The period is set for your company (14 days by default). Supplier activity on overdue work, such as accepting it or submitting it for review, restarts the period. If your company has turned stale tracking off, new work orders are not marked stale. If your company excludes self-managed suppliers from stale tracking, work orders assigned to a self-managed supplier are never marked stale. Moving work to or from a self-managed supplier clears or restarts its stale tracking.

Available options:
true,
false
createdByEmails
string

Work created by these people, by email address: createdByEmails=ops@example.com,manager@example.com. Comma-separated list; matches any value listed.

timezone
string

Optional IANA time zone name, such as America/Chicago or UTC, that this route's date filters are read in. Each date filter value is a local wall-clock time in this zone. When omitted, date filters are read in UTC. Names are case-sensitive. Fixed offsets (-05:00, GMT-5, Z, Etc/GMT+5), abbreviations (CST), and unknown names are rejected with 400. On a daylight saving change day, a time in the skipped hour moves forward by the length of the gap, and a time in the repeated hour means the standard-time (second) occurrence.

Example:

"America/Chicago"

Response

Success.

Envelope for count_by endpoints: data is a plain integer count.

type
string
required

Always "CountBy".

data
integer
required

The count.

status
enum<string>
required
Available options:
ok