Work orders

List work orders

Cursor-paginated, scoped to the token's account and role.

Besides the filter[<field>_<predicate>] fields, these filters take a plain value:

  • filter[attached_bill_id] — A bill id: the work orders that bill is attached to (the bill's work_orders).
  • filter[external_reference] — <type>:<id> of a PMS record, e.g. bill:815978 or work_order:148: the work orders that produced it. The types a work order carries are in its external_references.
  • filter[archived] — false (default) hides archived work orders, true returns only archived ones, all returns both.
get/v1/work_orders

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/work_orders
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

attached_bill_idstring

A bill id: the work orders that bill is attached to (the bill's work_orders).

external_referencestring

<type>:<id> of a PMS record, e.g. bill:815978 or work_order:148: the work orders that produced it. The types a work order carries are in its external_references.

archivedstring

false (default) hides archived work orders, true returns only archived ones, all returns both.

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: amount_with_markup, bill_to, bill_vendor_id, created_at, description, due_date, export_mode, external_id, external_status, id, is_owner_charge, name, payment_bill_vendor_id, payment_bill_vendor_name, performed_on, property_id, property_name, status, task_bill_to, task_department, task_external_id, task_integration_connection_id, task_status_code.

Comma-separated relationships to sideload into included.

Response

A page of work orders.

Changes

No recorded changes to this operation across all 1 revision of this API.