CourtOrder.GetExisting

Try it in Swagger

Endpoint

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token or Session/Create.

Path Parameters

Field Type Required Notes
workOrder string Yes Exported Winserve court work order. Use the workOrderId returned by CourtOrder.Create when export is true, or by OrderExport.Export. Use GetDraft/{webOrder} for draft/web order lookups.

This endpoint does not accept a JSON request body.

CourtOrder.GetExisting does not look up draft web orders. If CourtOrder.Create is called without export: true, the response is only the draft webOrder value and the order should be read with CourtOrder.GetDraft/{webOrder} until it is exported.

See the Order Lifecycle guide for how draft web order ids become exported work order ids.

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
404 Not Found Exported court work order was not found for the authenticated customer.

Success Body

Response type: ExistingCourtResponse

Field Type Required Max Length Notes
workOrder string Yes
customer string Yes
contactCode int? No
caseType int? No
jobCategory string Yes
referenceNumber string Yes
adjuster int? No
billToAdjuster int? No
plaintiff string Yes
defendant string Yes
courtCode string Yes 12 Court code, not the court display name. See Court.Search, Court.GetAll, or Court.Get for court lookup details.
stateCode string Yes
county string Yes
caseNumber string Yes
claimNumber string Yes
department string Yes
room string Yes
hearingDate DateTime? No
winserveWorkOrder string Yes Exported Winserve work order. This matches workOrder for this endpoint.
status string Yes Current workflow state. Returns Completed when proof of delivery exists, otherwise the current milestone title when available, or E-Filed / Active fallback values.
milestone string Yes Current court milestone title from the tenant database.
specialInstructions string Yes
jobType string Yes Job type title shown on the ProcessStatus detail page.
caseDetails ExistingCourtCaseDetailsResponse No Case details shown on the ProcessStatus detail page.
statusUpdates ExistingCourtStatusUpdateResponse[] Yes Status update timeline from the tenant ProcessStatus table.
deliveryInformation ExistingCourtDeliveryInformationResponse? No Court proof of delivery/completion information.
invoiceDetails ExistingCourtInvoiceDetailResponse[] Yes Latest Winserve Plus invoice detail lines, including a total line when invoice lines exist.
downloads ExistingCourtDownloadResponse[] Yes Downloadable work order attachments shown on the ProcessStatus detail page.
hasStatusUpdates bool Yes Indicates status update rows exist.
hasInvoice bool Yes Indicates invoice detail rows exist.
hasProofOfDelivery bool Yes Indicates proof of delivery exists.
hasDownloads bool Yes Indicates downloadable attachments exist.

Workflow status and order details are resolved from the tenant database selected by X-Api-Key or subdomain. Court milestones are tenant-local rows in the tenant Milestone table. The detail payload mirrors the court order details loaded by the ProcessStatus page.

Response Sample

{
  "workOrder": "CL123456",
  "customer": "ABC Legal Services",
  "contactCode": 456,
  "caseType": 123,
  "jobCategory": "Court Filing",
  "referenceNumber": "REF-12345",
  "adjuster": 123,
  "billToAdjuster": 123,
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "courtCode": "LASC",
  "stateCode": "CA",
  "county": "Los Angeles",
  "caseNumber": "24STCV12345",
  "claimNumber": "CLM-12345",
  "department": "Dept 12",
  "room": "Room 305",
  "hearingDate": "2026-05-07T00:00:00",
  "winserveWorkOrder": "CL123456",
  "status": "AT COURT",
  "milestone": "AT COURT",
  "specialInstructions": "Call before delivery.",
  "jobType": "Court Filing",
  "caseDetails": {
    "contact": "Maria Contact",
    "dateReceived": "2026-05-07T00:00:00",
    "case": "24STCV12345",
    "claimNumber": "CLM-12345",
    "plaintiff": "Acme Corporation",
    "defendant": "John Doe",
    "fileDate": "2026-05-14T00:00:00",
    "documentsServed": "Summons and complaint",
    "referenceNumber": "REF-12345",
    "attorney": "Jane Attorney",
    "hearingDate": "2026-05-07T00:00:00",
    "hearingTime": "09:30 AM",
    "courtName": "Los Angeles Superior Court",
    "address1": "111 N Hill St",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": "90012",
    "downloads": [],
    "images": []
  },
  "statusUpdates": [],
  "deliveryInformation": null,
  "invoiceDetails": [],
  "downloads": [],
  "hasStatusUpdates": false,
  "hasInvoice": false,
  "hasProofOfDelivery": false,
  "hasDownloads": false
}