Evictions API

Attorney endpoints

Called with an attorney token to review a case and record its steps. They act on test cases, where a built-in reviewer uses them; a real case is handled by the attorney engaged for it and does not go through these endpoints. An API key cannot call them. Customers integrating the API do not need them; they are listed so the reference is complete.

The examples use https://api.evictionsapi.com and placeholder keys. Conventions shared by all endpoints (errors, idempotency, pagination) are in the API reference.

What is available todayYou can start a real eviction case with Evictions API for a rental property in any US state or DC. After you submit a case, we engage a licensed attorney in the property’s state for it and confirm by email. Nothing is served on a tenant or filed in court until that attorney has reviewed the case.The full statement

Endpoints

GET /v1/attorney/queue

Cases awaiting the attorney's review, and assigned cases that need attention

Authentication: Attorney token, as Authorization: Bearer eut_...

Responses

StatusMeaningBody
200Cases in notice or filing review, and open cases on hold or with a failed job, oldest first.{ items: AttorneyQueueItem[] }
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
422The case did not pass a check.Error

Example

curl example for GET /v1/attorney/queue
curl https://api.evictionsapi.com/v1/attorney/queue \
  -H "Authorization: Bearer eut_..."

GET /v1/attorney/cases/{id}

A case with its documents, evidence, gate results, filings, service attempts and full audit trail; the access is audited

Authentication: Attorney token, as Authorization: Bearer eut_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The case in attorney detail.AttorneyCase
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
422The case did not pass a check.Error

Example

curl example for GET /v1/attorney/cases/{id}
curl https://api.evictionsapi.com/v1/attorney/cases/case_... \
  -H "Authorization: Bearer eut_..."

GET /v1/attorney/cases/{id}/documents/{docId}

Download a document; the access is audited

Authentication: Attorney token, as Authorization: Bearer eut_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
docIdpathstringYesThe document id.

Responses

StatusMeaningBody
200The document bytes.binaryapplication/pdf
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
410`erased`: the details of the case were erased, and the document's content with them.Error
422The case did not pass a check.Error

Example

curl example for GET /v1/attorney/cases/{id}/documents/{docId}
curl https://api.evictionsapi.com/v1/attorney/cases/case_.../documents/doc_... \
  -H "Authorization: Bearer eut_..." \
  -o document.pdf

GET /v1/attorney/counsel-assignments

The calling attorney's limited counsel engagements: the one act each covers, its terms and the documents it grants

Authentication: Attorney token, as Authorization: Bearer eut_...

Responses

StatusMeaningBody
200The engagements, newest first.{ items: object[] }
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
422The case did not pass a check.Error

Example

curl example for GET /v1/attorney/counsel-assignments
curl https://api.evictionsapi.com/v1/attorney/counsel-assignments \
  -H "Authorization: Bearer eut_..."

GET /v1/attorney/counsel-assignments/{id}/documents/{docId}

Download a document an accepted engagement grants; the access is audited

Authentication: Attorney token, as Authorization: Bearer eut_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
docIdpathstringYesThe document id.

Responses

StatusMeaningBody
200The document bytes.binaryapplication/pdf
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
410`erased`: the details of the case were erased, and the document's content with them.Error
422The case did not pass a check.Error

Example

curl example for GET /v1/attorney/counsel-assignments/{id}/documents/{docId}
curl https://api.evictionsapi.com/v1/attorney/counsel-assignments/case_.../documents/doc_... \
  -H "Authorization: Bearer eut_..." \
  -o document.pdf

POST /v1/attorney/cases/{id}/reviews

Approve, reject or request changes, naming the document hashes reviewed

Authentication: Attorney token, as Authorization: Bearer eut_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
decisionstringYesOne of: "approve", "reject", "request_changes".
notesstringNo1 to 5000 characters.
documentHashesarray of stringYesUp to 50 items.

Responses

StatusMeaningBody
200The case after the decision.CaseForAttorney
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
422The case did not pass a check.Error

Example

curl example for POST /v1/attorney/cases/{id}/reviews
curl -X POST https://api.evictionsapi.com/v1/attorney/cases/case_.../reviews \
  -H "Authorization: Bearer eut_..." \
  -H "Content-Type: application/json" \
  -d '{
  "decision": "approve",
  "documentHashes": ["df75f3ea1d63370ba642bde84f53668817f063ac887beb86b8593d78cf5642b9"]
}'

POST /v1/attorney/cases/{id}/outcomes

Record a court outcome

Authentication: Attorney token, as Authorization: Bearer eut_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. The body is one of these shapes. Fields not listed are rejected.

When type is "hearing_scheduled"

NameTypeRequiredDescription
typestringYesAlways "hearing_scheduled".
datestringYes—

When type is "judgment"

NameTypeRequiredDescription
typestringYesAlways "judgment".
outcomestringYesOne of: "plaintiff", "defendant", "dismissed".

When type is "writ_requested"

NameTypeRequiredDescription
typestringYesAlways "writ_requested".

When type is "writ_issued"

NameTypeRequiredDescription
typestringYesAlways "writ_issued".

When type is "closed"

NameTypeRequiredDescription
typestringYesAlways "closed".

Responses

StatusMeaningBody
200The case after the outcome.CaseForAttorney
400The request is invalid.Error
401The credential is missing or invalid.Error
403The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).Error
404Not found.Error
409The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.Error
422The case did not pass a check.Error

Example

curl example for POST /v1/attorney/cases/{id}/outcomes
curl -X POST https://api.evictionsapi.com/v1/attorney/cases/case_.../outcomes \
  -H "Authorization: Bearer eut_..." \
  -H "Content-Type: application/json" \
  -d '{ "type": "hearing_scheduled", "date": "2026-11-02" }'

Response objects

The objects the attorney endpoints return. Response shapes are described by hand in the OpenAPI document and are deliberately loose.

AttorneyQueueItem

NameTypeRequiredDescription
idstringYes—
modestringYesOne of: "test", "live".
statestringYes—
groundstringYes—
entryPointstringYesOne of: "notice", "filing".
jurisdictionobjectYes—
jurisdiction.statestringYes—
jurisdiction.countystringNo—
attentionAttentionYes—
createdAtstringYesFormat: date-time.
updatedAtstringYesFormat: date-time.

Attention

Whether the case needs the attorney: it is on hold, or a job for it failed for good after its last state change.

NameTypeRequiredDescription
neededbooleanYes—
reasonsarray of stringYes—

AttorneyCase

The case as its assigned attorney sees it. Each read is recorded in the audit log as `tenant_data_viewed`.

NameTypeRequiredDescription
idstringYesThe case's key in the API, for example `case_21a1f8ed-79f4-4248-a682-10184ca8a5c1`.
referencestringYesThe 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.
modestringYesOne of: "test", "live".
statestringYesPosition in the case lifecycle, for example `notice_review` or `filing_submitted`.
heldFromstring | nullNo—
groundstringYes—
entryPointstringYesOne of: "notice", "filing".
courtCaseNumberstring | nullNo—
courtstring | nullNoThe 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.
packVersionsobject | nullNo—
dataobjectYes—
deadlinesarray of objectYes—
deadlines[].namestringYes—
deadlines[].datestringYesFormat: date.
deadlines[].citationstringYes—
documentsarray of DocumentYes—
nextActionobjectYes—
nextAction.bystringYesOne of: "customer", "attorney", "platform", "court", "none".
nextAction.descriptionstringYes—
handlingstringNoWho 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".
attorneyobject | nullNoThe attorney engaged for an attorney-direct case, once recorded. Null until then, and always null for a test case.
attorney.namestring | nullIf attorney is sent—
attorney.firmstringIf attorney is sent—
attorney.statestringIf attorney is sentThe property's state.
attorney.barNumberstring | nullIf attorney is sentThe attorney's bar number in that state.
erasedbooleanNoWhether 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`.
erasedAtstring | nullNoWhen the details were erased. Null for a case that was not erased. Format: date-time.
sourcesobjectNoWhere 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.
documentFillobjectNoA 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.filledarray of stringIf documentFill is sent—
documentFill.questionsarray of stringIf documentFill is sent—
documentFill.reasonsobjectNoFor 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.readingbooleanNoWhether documents added to a draft are read by themselves here.
gatesGateResultsYes—
agentbooleanNoPresent, 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.
authorizationobjectNoWhether 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.signedbooleanIf authorization is sent—
authorization.stalebooleanIf authorization is sent—
complaintSignatureobjectNoWhether 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.requiredbooleanIf complaintSignature is sent—
complaintSignature.signedbooleanIf complaintSignature is sent—
complaintSignature.swornbooleanNoAlways true.
complaintSignature.signerobjectNo—
complaintSignature.signer.userIdstringIf complaintSignature.signer is sent—
complaintSignature.signer.namestringIf complaintSignature.signer is sent—
paymentMethodIdstring | nullNoThe 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.
tasksarray of TaskNoEach outward step of the case, oldest first (as `GET /v1/cases/{id}/tasks`).
checkingobjectNoPresent 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.stagestringIf checking is sentOne of: "notice", "filing", "summons".
checking.sincestringIf checking is sentFormat: date-time.
sentBackobjectNoPresent 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.stagestringIf sentBack is sentOne of: "notice", "filing", "summons".
sentBack.notestringIf sentBack is sent—
sentBack.atstringIf sentBack is sentFormat: date-time.
claimobjectNoWhat 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.claimRentbooleanIf claim is sent—
claim.amountClaimedCentsintegerIf claim is sentUS cents. Zero when no money is claimed.
claim.itemsobjectNoThe 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.rentCentsintegerNo—
claim.items.lateFeesCentsintegerNo—
claim.items.utilitiesCentsintegerNo—
claim.items.otherCentsintegerNo—
hearingobjectNoThe 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.datestringIf hearing is sentFormat: date.
hearing.timestring | nullIf hearing is sentThe court's local time, HH:MM, when known.
hearing.placestring | nullIf hearing is sentWhere the court sits for the hearing, when known.
hearing.courtstring | nullIf hearing is sent—
hearing.clientAttendsbooleanIf hearing is sent—
courtRecordobjectNoWhat 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.submissionsarray of objectIf courtRecord is sent—
courtRecord.submissions[].idstringIf courtRecord is sent—
courtRecord.submissions[].portalstringIf courtRecord is sentThe court's e-filing portal, for example `eFileGA`.
courtRecord.submissions[].envelopeNumberstring | nullNo—
courtRecord.submissions[].statusstringIf courtRecord is sentOne of: "submitted", "under_review", "accepted", "rejected", "cancelled".
courtRecord.submissions[].statusLabelstringIf courtRecord is sentThe status in plain words.
courtRecord.submissions[].statusAtstringIf courtRecord is sentWhen the court gave the status (the review date), or when it was recorded. Format: date-time.
courtRecord.submissions[].statusHistoryarray of objectIf courtRecord is sent—
courtRecord.submissions[].statusHistory[].statusstringIf courtRecord is sent—
courtRecord.submissions[].statusHistory[].atstringIf courtRecord is sentFormat: date-time.
courtRecord.submissions[].submittedAtstring | nullNoFormat: date-time.
courtRecord.submissions[].acceptedAtstring | nullNoFormat: date-time.
courtRecord.submissions[].filingsarray of objectIf courtRecord is sent—
courtRecord.submissions[].filings[].codestring | nullNo—
courtRecord.submissions[].filings[].descriptionstringIf courtRecord is sent—
courtRecord.submissions[].filings[].documentIdstring | nullNoThe document of the case that was filed.
courtRecord.submissions[].reviewerCommentsstring | nullNoThe court clerk's comments or the reason for a rejection, word for word.
courtRecord.submissions[].courtCaseNumberstring | nullNo—
courtRecord.submissions[].feesarray of objectIf courtRecord is sent—
courtRecord.submissions[].fees[].labelstringIf courtRecord is sent—
courtRecord.submissions[].fees[].amountCentsintegerIf courtRecord is sentUS cents.
courtRecord.submissions[].totalCentsinteger | nullNoThe envelope's grand total, in US cents.
courtRecord.submissions[].transactionReferencestring | nullNo—
courtRecord.submissions[].stampedDocumentIdsarray of stringIf courtRecord is sentThe court's file-stamped copies, documents of the case (download each from `GET /v1/cases/{id}/documents/{docId}`).
courtRecord.submissions[].recordedAtstringNoFormat: date-time.
courtRecord.submissions[].updatedAtstringNoFormat: date-time.
courtRecord.noticesarray of objectIf courtRecord is sent—
courtRecord.notices[].idstringIf courtRecord is sent—
courtRecord.notices[].receivedAtstringIf courtRecord is sentFormat: date-time.
courtRecord.notices[].fromstringIf courtRecord is sent—
courtRecord.notices[].subjectstringIf courtRecord is sent—
courtRecord.notices[].bodystringIf courtRecord is sentThe notice's text, word for word.
courtRecord.notices[].documentIdsarray of stringIf courtRecord is sentDocuments of the case that came with the notice.
courtRecord.notices[].recordedAtstringNoFormat: date-time.
createdAtstringNoFormat: date-time.
updatedAtstringNoFormat: date-time.
evidencearray of DocumentYes—
filingsarray of FilingYesEvery court filing, oldest first.
serviceAttemptsarray of ServiceAttemptYesEvery service attempt, oldest first.
attentionAttentionYes—
eventsarray of EventYesThe full audit trail, including internal events.

CaseForAttorney

The case as an attorney sees it: the same as `Case`, without `openedBy` and `landlord`.

NameTypeRequiredDescription
idstringYesThe case's key in the API, for example `case_21a1f8ed-79f4-4248-a682-10184ca8a5c1`.
referencestringYesThe 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.
modestringYesOne of: "test", "live".
statestringYesPosition in the case lifecycle, for example `notice_review` or `filing_submitted`.
heldFromstring | nullNo—
groundstringYes—
entryPointstringYesOne of: "notice", "filing".
courtCaseNumberstring | nullNo—
courtstring | nullNoThe 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.
packVersionsobject | nullNo—
dataobjectYes—
deadlinesarray of objectYes—
deadlines[].namestringYes—
deadlines[].datestringYesFormat: date.
deadlines[].citationstringYes—
documentsarray of DocumentYes—
nextActionobjectYes—
nextAction.bystringYesOne of: "customer", "attorney", "platform", "court", "none".
nextAction.descriptionstringYes—
handlingstringNoWho 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".
attorneyobject | nullNoThe attorney engaged for an attorney-direct case, once recorded. Null until then, and always null for a test case.
attorney.namestring | nullIf attorney is sent—
attorney.firmstringIf attorney is sent—
attorney.statestringIf attorney is sentThe property's state.
attorney.barNumberstring | nullIf attorney is sentThe attorney's bar number in that state.
erasedbooleanNoWhether 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`.
erasedAtstring | nullNoWhen the details were erased. Null for a case that was not erased. Format: date-time.
sourcesobjectNoWhere 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.
documentFillobjectNoA 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.filledarray of stringIf documentFill is sent—
documentFill.questionsarray of stringIf documentFill is sent—
documentFill.reasonsobjectNoFor 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.readingbooleanNoWhether documents added to a draft are read by themselves here.
gatesobjectNoA draft only, on `GET /v1/cases/{id}` (not in a list): the submission checks as they stand now (`results` and `passed`), each failing one with its reason in words, as `POST /v1/cases/{id}/validate` gives them.
agentbooleanNoPresent, 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.
authorizationobjectNoWhether 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.signedbooleanIf authorization is sent—
authorization.stalebooleanIf authorization is sent—
complaintSignatureobjectNoWhether 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.requiredbooleanIf complaintSignature is sent—
complaintSignature.signedbooleanIf complaintSignature is sent—
complaintSignature.swornbooleanNoAlways true.
complaintSignature.signerobjectNo—
complaintSignature.signer.userIdstringIf complaintSignature.signer is sent—
complaintSignature.signer.namestringIf complaintSignature.signer is sent—
paymentMethodIdstring | nullNoThe 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.
tasksarray of TaskNoEach outward step of the case, oldest first (as `GET /v1/cases/{id}/tasks`).
checkingobjectNoPresent 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.stagestringIf checking is sentOne of: "notice", "filing", "summons".
checking.sincestringIf checking is sentFormat: date-time.
sentBackobjectNoPresent 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.stagestringIf sentBack is sentOne of: "notice", "filing", "summons".
sentBack.notestringIf sentBack is sent—
sentBack.atstringIf sentBack is sentFormat: date-time.
claimobjectNoWhat 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.claimRentbooleanIf claim is sent—
claim.amountClaimedCentsintegerIf claim is sentUS cents. Zero when no money is claimed.
claim.itemsobjectNoThe 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.rentCentsintegerNo—
claim.items.lateFeesCentsintegerNo—
claim.items.utilitiesCentsintegerNo—
claim.items.otherCentsintegerNo—
hearingobjectNoThe 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.datestringIf hearing is sentFormat: date.
hearing.timestring | nullIf hearing is sentThe court's local time, HH:MM, when known.
hearing.placestring | nullIf hearing is sentWhere the court sits for the hearing, when known.
hearing.courtstring | nullIf hearing is sent—
hearing.clientAttendsbooleanIf hearing is sent—
courtRecordobjectNoWhat 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.submissionsarray of objectIf courtRecord is sent—
courtRecord.submissions[].idstringIf courtRecord is sent—
courtRecord.submissions[].portalstringIf courtRecord is sentThe court's e-filing portal, for example `eFileGA`.
courtRecord.submissions[].envelopeNumberstring | nullNo—
courtRecord.submissions[].statusstringIf courtRecord is sentOne of: "submitted", "under_review", "accepted", "rejected", "cancelled".
courtRecord.submissions[].statusLabelstringIf courtRecord is sentThe status in plain words.
courtRecord.submissions[].statusAtstringIf courtRecord is sentWhen the court gave the status (the review date), or when it was recorded. Format: date-time.
courtRecord.submissions[].statusHistoryarray of objectIf courtRecord is sent—
courtRecord.submissions[].statusHistory[].statusstringIf courtRecord is sent—
courtRecord.submissions[].statusHistory[].atstringIf courtRecord is sentFormat: date-time.
courtRecord.submissions[].submittedAtstring | nullNoFormat: date-time.
courtRecord.submissions[].acceptedAtstring | nullNoFormat: date-time.
courtRecord.submissions[].filingsarray of objectIf courtRecord is sent—
courtRecord.submissions[].filings[].codestring | nullNo—
courtRecord.submissions[].filings[].descriptionstringIf courtRecord is sent—
courtRecord.submissions[].filings[].documentIdstring | nullNoThe document of the case that was filed.
courtRecord.submissions[].reviewerCommentsstring | nullNoThe court clerk's comments or the reason for a rejection, word for word.
courtRecord.submissions[].courtCaseNumberstring | nullNo—
courtRecord.submissions[].feesarray of objectIf courtRecord is sent—
courtRecord.submissions[].fees[].labelstringIf courtRecord is sent—
courtRecord.submissions[].fees[].amountCentsintegerIf courtRecord is sentUS cents.
courtRecord.submissions[].totalCentsinteger | nullNoThe envelope's grand total, in US cents.
courtRecord.submissions[].transactionReferencestring | nullNo—
courtRecord.submissions[].stampedDocumentIdsarray of stringIf courtRecord is sentThe court's file-stamped copies, documents of the case (download each from `GET /v1/cases/{id}/documents/{docId}`).
courtRecord.submissions[].recordedAtstringNoFormat: date-time.
courtRecord.submissions[].updatedAtstringNoFormat: date-time.
courtRecord.noticesarray of objectIf courtRecord is sent—
courtRecord.notices[].idstringIf courtRecord is sent—
courtRecord.notices[].receivedAtstringIf courtRecord is sentFormat: date-time.
courtRecord.notices[].fromstringIf courtRecord is sent—
courtRecord.notices[].subjectstringIf courtRecord is sent—
courtRecord.notices[].bodystringIf courtRecord is sentThe notice's text, word for word.
courtRecord.notices[].documentIdsarray of stringIf courtRecord is sentDocuments of the case that came with the notice.
courtRecord.notices[].recordedAtstringNoFormat: date-time.
createdAtstringNoFormat: date-time.
updatedAtstringNoFormat: date-time.

Filing

A submission to the court. Attorney-only.

NameTypeRequiredDescription
idstringYes—
statusstringYes`submitted`, `accepted` or `rejected`.
envelopeIdstring | nullYes—
courtCaseNumberstring | nullYes—
rejectionReasonsarray | nullYesThe court's reasons, when it rejected the filing.
createdAtstringYesFormat: date-time.

ServiceAttempt

One request to serve a document on one defendant. Attorney-only.

NameTypeRequiredDescription
idstringYes—
stagestringYesOne of: "notice", "summons".
methodstringYes—
statusstringYes`pending`, `served` or `failed`.
servedDatestring | nullYesFormat: date.
failureReasonstring | nullYesThe process server's reason, when service failed.
createdAtstringYesFormat: date-time.