WorkItems

List work-item lifecycle states

Returns the lifecycle states with display metadata, ordered by sortOrder. Filtered by work type via the optional workType query param: base (shared) states when omitted, and the type-specific states when provided (e.g. court_pickup adds ready_for_pickup).

get/v2/work-item-states

Request

  • Base URL: https://api-docs.proofserve.com
  • URL: https://api-docs.proofserve.com/v2/work-item-states
  • Auth: none declared

Query parameters

workTypestring

Stable identifier for a work type, as registered in the work-type registry. Deliberately an open string rather than an enum: work types are plug-ins, and the set is served by GET /v2/work-types — pinning it here would make adding one a five-artifact change (Go implementation, registry line, this spec, Go regen, webapp regen) and would give clients a literal union that has to be widened in lockstep with the server. Nothing validates it against this schema; an unregistered code is rejected at runtime with 422.

Example:court_pickup

Restrict the states to those valid for this work type.

Response

The lifecycle states for the requested work type.

Example response

{
  "data": [
    {
      "code": "ready_for_pickup",
      "name": "Ready for Pickup",
      "instruction": "Call the court before heading there."
    }
  ],
  "meta": {
    "requestId": "req_8xKp2mN4"
  }
}

Changes

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