id | string | Yes | The case's key in the API, for example `case_21a1f8ed-79f4-4248-a682-10184ca8a5c1`. |
reference | string | Yes | The case's short reference, for example `EV-1001`: what our emails and the app show. `GET /v1/cases/{id}` also accepts it in place of the id. |
mode | string | Yes | One of: "test", "live". |
state | string | Yes | Position in the case lifecycle, for example `notice_review` or `filing_submitted`. |
heldFrom | string | null | No | — |
ground | string | Yes | — |
entryPoint | string | Yes | One of: "notice", "filing". |
courtCaseNumber | string | null | No | — |
court | string | null | No | The court the case goes to, in words, where the rules for its place say which, with the county: for example "Magistrate court of Henry County". `null` where no rule pack covers the place, and for an erased case. |
packVersions | object | null | No | — |
data | object | Yes | — |
deadlines | array of object | Yes | — |
deadlines[].name | string | Yes | — |
deadlines[].date | string | Yes | Format: date. |
deadlines[].citation | string | Yes | — |
documents | array of Document | Yes | — |
nextAction | object | Yes | — |
nextAction.by | string | Yes | One of: "customer", "attorney", "platform", "court", "none". |
nextAction.description | string | Yes | — |
handling | string | No | Who does the legal work. `attorney_direct`: a licensed attorney engaged for the case reviews it, serves the notice and files in court, and the platform records each step; it is what a live case is where the full-service path is not open for its property. `automated`: the built-in test pipeline of a test case. `agent_filed`, the full-service path, as we describe it to the owner: We act as your authorized agent. No attorney reviews the case. We are not a law firm and do not give legal advice. A live case is created with it wherever that path is open for the property; a test case when `POST /v1/cases` asks for `service: "full"`. It needs the owner's signed authorization (`/v1/cases/{id}/authorization`). One of: "automated", "attorney_direct", "agent_filed". |
attorney | object | null | No | The attorney engaged for an attorney-direct case, once recorded. Null until then, and always null for a test case. |
attorney.name | string | null | If attorney is sent | — |
attorney.firm | string | If attorney is sent | — |
attorney.state | string | If attorney is sent | The property's state. |
attorney.barNumber | string | null | If attorney is sent | The attorney's bar number in that state. |
erased | boolean | No | Whether the details of the case were erased, which we do case by case on request. An erased case keeps its id, state, dates, deadline names and charges. In `data` the names and the address read `[erased]` (the state and county are kept) and every other fact is gone; `courtCaseNumber` is null; each document keeps its id and `contentHash`, its `filename` reads `[erased]` and downloading it answers 410 `erased`; messages read `[erased]`. Any request that would change the case answers 409 `erased`. |
erasedAt | string | null | No | When the details were erased. Null for a case that was not erased. Format: date-time. |
sources | object | No | Where each answer came from, by field path (`property.line1`, `lease.monthlyRentCents`, `parties.0`, `ledger`): the kind of source, and for a file read the id of the case document it was read from. An answer with no entry was typed. Empty when no answer came from a source. Never holds a value. Send `sources` with `POST /v1/cases` or `PATCH /v1/cases/{id}` to set it (a patch replaces the whole map); a patch that changes an answer without sending `sources` removes that answer's entry. In a patch, a path sent as `null` removes its entry. The kind `document_read` is recorded only by our own reading of the case's documents: an entry of that kind stays while its answer is unchanged (send the path as `null` to remove it), and sending the kind for an answer that has no such entry answers 422. The kinds `saved_landlord` (the address and telephone of a landlord you saved under the plaintiff's name) and `previous_case` (those of your earlier case with the same plaintiff) are recorded by us the same way. |
documentFill | object | No | A draft only, on `GET /v1/cases/{id}` (not in a list). `filled`: the field paths of the answers read from the case's own uploaded documents to fill what the draft lacked (the entries of `sources` with the kind `document_read`); check each, and change any with `PATCH /v1/cases/{id}`. An answer you sent is never replaced, and nothing is filled that no document states. `questions`: what the submission checks still miss, as field paths, and `parties.plaintiff`, `parties.defendant` or `ledger.kind` (the kind of each ledger charge). Names only, never a value. |
documentFill.filled | array of string | If documentFill is sent | — |
documentFill.questions | array of string | If documentFill is sent | — |
documentFill.reasons | object | No | For a question that was looked for and not filled, why, as a code: `not_stated`, `no_document_read`, `low_confidence`, `invalid_value`, `document_names_other_tenants`, `document_names_no_tenant`, `landlord_is_not_plaintiff`, `address_or_phone_missing`, `ledger_not_whole`, `ledger_rows_not_matched`, `ledger_kinds_incomplete`, `saved_details_ambiguous`, `cleared_by_person` or `not_fillable`. `POST /v1/cases/{id}/validate` says each in a sentence (`missingReasons`). |
documentFill.reading | boolean | No | Whether documents added to a draft are read by themselves here. |
gates | GateResults | Yes | — |
agent | boolean | No | Present, and true, only for an agent-filed case (`handling: "agent_filed"`): we act as your authorized agent, no attorney reviews the case, and we are not a law firm and do not give legal advice. Every field below appears only with it. Always true. |
authorization | object | No | Whether your authorization for us to act as your agent is signed, and whether the facts changed after it was signed (then nothing more is done until you sign again). |
authorization.signed | boolean | If authorization is sent | — |
authorization.stale | boolean | If authorization is sent | — |
complaintSignature | object | No | Whether the court requires the owner to sign the complaint, and whether the current complaint is signed. While it is required and unsigned, the case waits in `filing_approved`. `sworn` (true when present): the filing is an affidavit your named person swears under oath by electronic verification in the app. `signer`: the member the case names to sign it, by user id and the name the filing prints; only that person can sign. |
complaintSignature.required | boolean | If complaintSignature is sent | — |
complaintSignature.signed | boolean | If complaintSignature is sent | — |
complaintSignature.sworn | boolean | No | Always true. |
complaintSignature.signer | object | No | — |
complaintSignature.signer.userId | string | If complaintSignature.signer is sent | — |
complaintSignature.signer.name | string | If complaintSignature.signer is sent | — |
paymentMethodId | string | null | No | The organization's saved card (`GET /v1/payment-methods`) this case's costs are charged to, or null for the default card. Choose it with `PATCH /v1/cases/{id}`. A chosen card that is removed or declined is not charged: the default card is used instead. |
tasks | array of Task | No | Each outward step of the case, oldest first (as `GET /v1/cases/{id}/tasks`). |
checking | object | No | Present while we check what the next step sends before it is sent (we check every notice, filing and summons for now): `notice` (the notice to the tenant), `filing` (the court filing) or `summons`. Nothing is sent, and nothing is charged for that step, until it is checked. |
checking.stage | string | If checking is sent | One of: "notice", "filing", "summons". |
checking.since | string | If checking is sent | Format: date-time. |
sentBack | object | No | Present while the case is on hold because we checked a step before sending it and sent the case back to you: nothing was sent. `note` says why; reply by email, or withdraw the case. |
sentBack.stage | string | If sentBack is sent | One of: "notice", "filing", "summons". |
sentBack.note | string | If sentBack is sent | — |
sentBack.at | string | If sentBack is sent | Format: date-time. |
claim | object | No | What the complaint asks the court for besides possession: unpaid rent, where the court lets us claim it as your agent, up to the court's limit where it has one. |
claim.claimRent | boolean | If claim is sent | — |
claim.amountClaimedCents | integer | If claim is sent | US cents. Zero when no money is claimed. |
claim.items | object | No | The claim by kind of charge, in US cents, where it includes charges besides rent (a place whose `documentFacts.claimKinds` allows them); the four add up to `amountClaimedCents`. |
claim.items.rentCents | integer | No | — |
claim.items.lateFeesCents | integer | No | — |
claim.items.utilitiesCents | integer | No | — |
claim.items.otherCents | integer | No | — |
hearing | object | No | The hearing, once the court has set one (or moved it): where the owner attends in person (`clientAttends`), you must attend it yourself; no one from the platform appears in your place. |
hearing.date | string | If hearing is sent | Format: date. |
hearing.time | string | null | If hearing is sent | The court's local time, HH:MM, when known. |
hearing.place | string | null | If hearing is sent | Where the court sits for the hearing, when known. |
hearing.court | string | null | If hearing is sent | — |
hearing.clientAttends | boolean | If hearing is sent | — |
courtRecord | object | No | What the court's e-filing portal (eFileGA, for example) shows of the case, as we record it from the portal: every envelope sent to the court, newest first, and the notices the court or the portal sent, newest first. Both are empty until something was filed. The case's `state` is moved separately; an envelope accepted with a court case number sets `courtCaseNumber`. |
courtRecord.submissions | array of object | If courtRecord is sent | — |
courtRecord.submissions[].id | string | If courtRecord is sent | — |
courtRecord.submissions[].portal | string | If courtRecord is sent | The court's e-filing portal, for example `eFileGA`. |
courtRecord.submissions[].envelopeNumber | string | null | No | — |
courtRecord.submissions[].status | string | If courtRecord is sent | One of: "submitted", "under_review", "accepted", "rejected", "cancelled". |
courtRecord.submissions[].statusLabel | string | If courtRecord is sent | The status in plain words. |
courtRecord.submissions[].statusAt | string | If courtRecord is sent | When the court gave the status (the review date), or when it was recorded. Format: date-time. |
courtRecord.submissions[].statusHistory | array of object | If courtRecord is sent | — |
courtRecord.submissions[].statusHistory[].status | string | If courtRecord is sent | — |
courtRecord.submissions[].statusHistory[].at | string | If courtRecord is sent | Format: date-time. |
courtRecord.submissions[].submittedAt | string | null | No | Format: date-time. |
courtRecord.submissions[].acceptedAt | string | null | No | Format: date-time. |
courtRecord.submissions[].filings | array of object | If courtRecord is sent | — |
courtRecord.submissions[].filings[].code | string | null | No | — |
courtRecord.submissions[].filings[].description | string | If courtRecord is sent | — |
courtRecord.submissions[].filings[].documentId | string | null | No | The document of the case that was filed. |
courtRecord.submissions[].reviewerComments | string | null | No | The court clerk's comments or the reason for a rejection, word for word. |
courtRecord.submissions[].courtCaseNumber | string | null | No | — |
courtRecord.submissions[].fees | array of object | If courtRecord is sent | — |
courtRecord.submissions[].fees[].label | string | If courtRecord is sent | — |
courtRecord.submissions[].fees[].amountCents | integer | If courtRecord is sent | US cents. |
courtRecord.submissions[].totalCents | integer | null | No | The envelope's grand total, in US cents. |
courtRecord.submissions[].transactionReference | string | null | No | — |
courtRecord.submissions[].stampedDocumentIds | array of string | If courtRecord is sent | The court's file-stamped copies, documents of the case (download each from `GET /v1/cases/{id}/documents/{docId}`). |
courtRecord.submissions[].recordedAt | string | No | Format: date-time. |
courtRecord.submissions[].updatedAt | string | No | Format: date-time. |
courtRecord.notices | array of object | If courtRecord is sent | — |
courtRecord.notices[].id | string | If courtRecord is sent | — |
courtRecord.notices[].receivedAt | string | If courtRecord is sent | Format: date-time. |
courtRecord.notices[].from | string | If courtRecord is sent | — |
courtRecord.notices[].subject | string | If courtRecord is sent | — |
courtRecord.notices[].body | string | If courtRecord is sent | The notice's text, word for word. |
courtRecord.notices[].documentIds | array of string | If courtRecord is sent | Documents of the case that came with the notice. |
courtRecord.notices[].recordedAt | string | No | Format: date-time. |
createdAt | string | No | Format: date-time. |
updatedAt | string | No | Format: date-time. |
evidence | array of Document | Yes | — |
filings | array of Filing | Yes | Every court filing, oldest first. |
serviceAttempts | array of ServiceAttempt | Yes | Every service attempt, oldest first. |
attention | Attention | Yes | — |
events | array of Event | Yes | The full audit trail, including internal events. |