WorkItems

List work items

Returns work items newest-first, cursor-paginated (Tier 1). Use startingAfter = cursors.next to page forward and endingBefore = cursors.previous to page back; the two are mutually exclusive. Cursors are opaque — do not construct or parse them.

Optional filters narrow the result and are ANDed: status[] (repeatable — match any of the given lifecycle status codes, ORed together), createdAfter (inclusive lower bound, createdAt >= value) and createdBefore (exclusive upper bound, createdAt < value). The two date bounds form a half-open window, so a client expresses "after a day" with createdAfter, "before a day" with createdBefore, and "on a day" by setting both to that day's UTC start and the next day's UTC start.

get/v2/work-items

Request

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

Query parameters

limitinteger

Page size (1–100).

startingAfterstring

Opaque forward cursor (cursors.next from a prior response).

endingBeforestring

Opaque backward cursor (cursors.previous from a prior response).

status[]string[]

Filter to work items whose lifecycle status is one of these codes. Repeat the parameter to match multiple statuses (ORed).

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

Filter to work items of this work type (exact match).

assigneeUserIdinteger

Filter to work items assigned to this process-server user. Internal (Proof) callers may filter by any assignee; a non-internal caller is always scoped to their own assigned items regardless of this value.

createdAfterstring date-time

Inclusive lower bound on createdAt (RFC 3339, UTC): return work items created at or after this instant.

createdBeforestring date-time

Exclusive upper bound on createdAt (RFC 3339, UTC): return work items created strictly before this instant.

Response

A page of work items.

hasMoreboolean required

Whether more items exist beyond this page in the requested direction.

Example response

{
  "data": [
    {
      "workType": "court_pickup",
      "title": "Jefferson County Circuit Court · 24-CV-00123",
      "status": "ready_for_pickup",
      "instruction": "Call the court before heading there.",
      "documents": [
        {
          "kind": "scanned_copy",
          "kindLabel": "Scanned copy"
        }
      ],
      "lineItems": [
        {
          "description": "Court pickup fee"
        }
      ],
      "totalPayoutAmountCents": 2500
    }
  ],
  "meta": {
    "requestId": "req_8xKp2mN4"
  }
}

Changes

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