Start and track a US eviction case in any state or DC; a licensed attorney reviews each real case.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Optional. `Bearer <key>` with an Evictions API key, for the tools that work with cases; a client that supports MCP sign-in (OAuth) can sign in instead. The other tools need no key.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Use this when the person asks you to add a document to a draft case: the lease, the tenant ledger, emails or messages with the tenant, proof that they own or manage the property, or a notice already served and its proof of service. Input: the case `id`, `filename`, `purpose` and `contentBase64` (a PDF, JPEG or PNG of about 700 KB at most through this server; a file up to 4 MB goes through `POST /v1/cases/{id}/documents` with the person’s key). Adds the document to the case; each call adds one more, but a repeat with the same `idempotencyKey` is safe (it returns the first answer). Works on a draft; after a live case is submitted, only a document with the purpose `other` can be added. Returns the document as stored. Do not use this when no case exists yet (use evictions_send_intake_file) or to change the case’s facts (use evictions_update_case). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.
The case id (case_...), as returned by evictions_create_case or evictions_list_cases.
What the document is: the lease, the tenant ledger, correspondence (emails or messages with the tenant), authority (proof the person owns or manages the property), prior_notice (a notice already served), prior_notice_proof (proof that notice was served), or other.
The file’s name, such as lease.pdf. Its type is read from the file itself, not from the name.
The file itself, base64-encoded: a PDF, JPEG or PNG of about 700 KB at most (950,000 base64 characters). A larger file, up to 4 MB, goes through the API directly.
Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of the document added twice. Always pass one, and reuse it if you repeat the call.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Use this when the person asks you to add a document to a draft case: the lease, the tenant ledger, emails or messages with the tenant, proof that they own or manage the property, or a notice already served and its proof of service. Input: the case `id`, `filename`, `purpose` and `contentBase64` (a PDF, JPEG or PNG of about 700 KB at most through this server; a file up to 4 MB goes through `POST /v1/cases/{id}/documents` with the person’s key). Adds the document to the case; each call adds one more, but a repeat with the same `idempotencyKey` is safe (it returns the first answer). Works on a draft; after a live case is submitted, only a document with the purpose `other` can be added. Returns the document as stored. Do not use this when no case exists yet (use evictions_send_intake_file) or to change the case’s facts (use evictions_update_case). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
| purpose* | string | What the document is: the lease, the tenant ledger, correspondence (emails or messages with the tenant), authority (proof the person owns or manages the property), prior_notice (a notice already served), prior_notice_proof (proof that notice was served), or other. |
| filename* | string | The file’s name, such as lease.pdf. Its type is read from the file itself, not from the name. |
| contentBase64* | string | The file itself, base64-encoded: a PDF, JPEG or PNG of about 700 KB at most (950,000 base64 characters). A larger file, up to 4 MB, goes through the API directly. |
| idempotencyKey | string | Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of the document added twice. Always pass one, and reuse it if you repeat the call. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"filename",
"purpose",
"contentBase64"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
},
"purpose": {
"enum": [
"lease",
"ledger",
"correspondence",
"authority",
"prior_notice",
"prior_notice_proof",
"other"
],
"type": "string",
"description": "What the document is: the lease, the tenant ledger, correspondence (emails or messages with the tenant), authority (proof the person owns or manages the property), prior_notice (a notice already served), prior_notice_proof (proof that notice was served), or other."
},
"filename": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The file’s name, such as lease.pdf. Its type is read from the file itself, not from the name."
},
"contentBase64": {
"type": "string",
"maxLength": 950000,
"minLength": 1,
"description": "The file itself, base64-encoded: a PDF, JPEG or PNG of about 700 KB at most (950,000 base64 characters). A larger file, up to 4 MB, goes through the API directly."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\x21-\\x7E]+$",
"maxLength": 255,
"minLength": 1,
"description": "Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of the document added twice. Always pass one, and reuse it if you repeat the call."
}
}
}Use this when the person wants to start an eviction case and has given you its facts: the ground, where the case starts, the property, the parties and their own attestations. Creates a draft case in the person’s account. Nothing is submitted. Add its documents with evictions_add_case_document. Pass an `idempotencyKey` and reuse it if you repeat the call, so a retry never makes a second case. For a property manager, `landlordId` (from evictions_list_landlords) names the owner the case is for and adds its saved management agreement to the case. Do not use this to change a case that already exists (use evictions_update_case). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| lease | object | The lease, when there is one. |
| ground* | string | Why the case is brought: nonpayment of rent, a lease violation, or holdover (the tenant stayed after the lease ended). Cannot be changed later. |
| ledger | array | Rent charges and payments, for a nonpayment case. |
| parties* | array | The plaintiff (the owner or manager) and each defendant (tenant). |
| freeText | string | Anything else the attorney should know. |
| property* | object | The rental property and its owner of record. |
Use this when you need one case in full: where it stands and what it is waiting on. Input: the case `id`. Returns its facts, deadlines, documents and, for a live case, the attorney once recorded. Do not use this to find a case whose id you do not have (use evictions_list_cases) or for its history (use evictions_get_case_events). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
}
}
}Use this when the person asks what has happened on a case so far. Input: the case `id`. Returns the events the person may see, oldest first, each with what happened, the state before and after, and when. Do not use this for where the case stands now (use evictions_get_case) or for messages (use evictions_list_case_messages). Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
}
}
}Use this when the person wants to pay a due charge on a case. Input: the case `id` and the `chargeId` from evictions_list_case_charges. Opens a hosted checkout for one due charge and returns its URL; asked again while that checkout is open, it returns the same URL. Give the URL to the person: paying is theirs to do, and no tool takes card details. Refused when the charge is not due or online payment is off. Do not use this to see whether a charge is paid (use evictions_list_case_charges). Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
| chargeId* | string | The id of a due charge on that case, from evictions_list_case_charges. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"chargeId"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
},
"chargeId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The id of a due charge on that case, from evictions_list_case_charges."
}
}
}Use this when the person asks what a case costs or about refunds. Takes no input. Returns the platform fee, the costs that are separate from it and the refund rule, word for word as the pricing page says them, with its link. Do not use this for the charges already on a case (use evictions_list_case_charges). No key needed.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Use this when the person asks what Evictions API is, what is available today, how a real case is handled or who operates it. Takes no input. Returns the service’s description, its current status and who operates it, in the site’s own words, with links to the home and how-it-works pages. Do not use this for fees (use evictions_get_pricing) or for one state’s rules (use evictions_get_state_eviction_facts). No key needed.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Use this when the person has no account or key yet, or asks how to connect an agent. Takes no input. Returns the sign-up link, what test and live keys are, how this MCP server is reached and signed in to, and the links to the docs and the OpenAPI document. Do not use this to check a key the person already has: any tool that works with cases says so when its key is missing or refused. No key needed.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Use this when the person asks how eviction works in one state, such as the notice for nonpayment of rent or the court. Input: `state`, as a two-letter code, a name or a slug. Returns the page’s opening answer and only the facts published as verified and sourced for that state, each with its citation, source link, the date it was checked and a short quote of the cited text where there is one (a fact checked more than 90 days ago is left out), plus the state’s page and a notice that this is general information, not legal advice; a state with none says so. Do not use this for whether a case can be opened at an address (use evictions_resolve_jurisdiction) or for advice on a particular case. No key needed.
| Argument | Type | Description |
|---|---|---|
| state* | string | A two-letter code (TX), a state name (Texas) or its slug (texas). DC is the District of Columbia. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "A two-letter code (TX), a state name (Texas) or its slug (texas). DC is the District of Columbia."
}
}
}Use this when the person asks what they owe on a case or whether a charge is paid. Input: the case `id`. Returns the charges on a case, oldest first, each with its id, kind, amount in cents and status (due, paid, void or refunded), and whether online payment is available. Do not use this for the published prices (use evictions_get_pricing). Next: evictions_get_payment_link for a due charge. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
}
}
}Use this when the person asks whether the Evictions API team has written about a case, or before writing to it. Input: the case `id`. Returns the messages on a case, the person’s own and the team’s, oldest first, each with its author, text and time. Do not use this for the case’s events (use evictions_get_case_events). Next: evictions_send_case_message to reply. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
}
}
}Use this when you need the person’s cases, or the id of a case you do not have. Input: optional `limit` and `cursor`, and `landlordId` for only one landlord’s cases (`none` for the cases with no landlord). Returns the cases of the key’s organization and mode (test or live), newest first, a page at a time, each with its `state` and `nextAction`, and `nextCursor` for the next page (null on the last). Do not use this when you already have the case id (use evictions_get_case). Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many to return, at most 100. The default is 20. |
| cursor | string | `nextCursor` from the page before, for the next page. Leave it out for the first page. |
| landlordId | string | Only the cases of this landlord (lnd_..., from evictions_list_landlords), or `none` for the cases with no landlord. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many to return, at most 100. The default is 20."
},
"cursor": {
"type": "string",
"maxLength": 512,
"description": "`nextCursor` from the page before, for the next page. Leave it out for the first page."
},
"landlordId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "Only the cases of this landlord (lnd_..., from evictions_list_landlords), or `none` for the cases with no landlord."
}
}
}Use this when the person is a property manager and you need the owner a case is for, or to list one owner’s cases. Input: optional `includeArchived`. Returns the organization’s landlords (the owners it acts for, saved in the app), by name, each with its `id`, `name`, whether it is `archived` and how many cases in this mode name it; their contact details stay in the app. Live keys only: with a test key the list is always empty, since landlords are real owners, and a test case cannot take one. Do not use this to add or change a landlord (the person does that on the Landlords page of the app). Next: evictions_create_case with `landlordId`, or evictions_list_cases with `landlordId`. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| includeArchived | boolean | True to list archived landlords too. They keep their cases but cannot be chosen for a new one. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"includeArchived": {
"type": "boolean",
"description": "True to list archived landlords too. They keep their cases but cannot be chosen for a new one."
}
}
}Use this when you need every place the service covers, or the exact code or slug of a state. Takes no input. Returns the 50 states and DC, each with its two-letter code, name, slug and page on the site. Do not use this for one state’s eviction rules (use evictions_get_state_eviction_facts). No key needed.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Use this when you need to know, before creating a case, whether a case can be opened for a property’s location and which facts each ground of eviction needs there. Input: `state`, and `county` and `city` when known. Returns whether the jurisdiction is served and, for each ground, the facts a case needs, and with a test key also the notice rules of the fictional state ZZ. Do not use this for a state’s published facts with their sources (use evictions_get_state_eviction_facts, which needs no key). Next: evictions_create_case. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| city | string | City of the property, when known. |
| state* | string | Two-letter state code, for example TX; DC for the District of Columbia. Test keys use the fictional state ZZ. |
| county | string | County of the property, when known, as the US Census Bureau names it ("Henry County" or "Henry"). The answer names the court the place's rules say the case goes to (`court`). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"state"
],
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "City of the property, when known."
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, for example TX; DC for the District of Columbia. Test keys use the fictional state ZZ."
},
"county": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "County of the property, when known, as the US Census Bureau names it (\"Henry County\" or \"Henry\"). The answer names the court the place's rules say the case goes to (`court`)."
}
}
}Use this when the person asks you to write to the Evictions API team about one of their live cases. Input: the case `id` and `body`. Sends the team a message about a live case, in the person’s name, and the team is told by email. Send only what the person asked to say. Each call sends one more message; a test case is refused, and an organization can send at most 20 every 10 minutes. Returns the message as stored. Do not use this to change a draft (use evictions_update_case). Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
| body* | string | The message, in the person’s words: only what they asked to say. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"body"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
},
"body": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The message, in the person’s words: only what they asked to say."
}
}
}Use this when the person asks you to send a file (their lease, the tenant ledger, emails or messages with the tenant) to Evictions API before a case exists. Input: `filename`, `contentBase64` (a PDF, JPEG or PNG of about 700 KB at most through this server; a file up to 4 MB goes through `POST /v1/intake/files` with the person’s key) and optionally `purpose` and a short `note`. The file waits in the person’s inbox, where they start a case from it. Needs a live key: with a test key, create a test case and use evictions_add_case_document. Returns the file’s id, its type, the purpose guessed for it and when it leaves the inbox if no case is started from it. Each call sends one more file, but a repeat with the same `idempotencyKey` is safe (it returns the first answer). Do not use this when the case already exists (use evictions_add_case_document), and do not create the case yourself: the person starts it from the inbox. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| note | string | A short note the person sees with the file, such as which property or tenant it is about. |
| purpose | string | What the file is, if you know: the lease, the tenant ledger, correspondence (emails or messages with the tenant), or other. Left out, it is guessed from the file’s name, and the person can change it. |
| filename* | string | The file’s name, such as lease.pdf. Its type is read from the file itself, not from the name. |
| contentBase64* | string | The file itself, base64-encoded: a PDF, JPEG or PNG of about 700 KB at most (950,000 base64 characters). A larger file, up to 4 MB, goes through the API directly. |
Use this when the person has said yes to submitting a draft that passes every check. Input: the case `id` and `confirmedByPerson`. A live case moves to `submitted`, its platform fee becomes a due charge, and a licensed attorney in the property’s state is engaged for it; nothing is served or filed until that attorney has reviewed it. With a test key the case is fictional and goes through a simulated review instead. With a live key this acts on a real case. Confirm with the person first, then pass `confirmedByPerson: true`. The case’s attestations must be the person’s own statements; never fill them in yourself. Do not use this to check a draft (use evictions_validate_case). Returns the case and its check results. Next: evictions_list_case_charges for the fee. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
| confirmedByPerson* | boolean | Set to true only after the person has said yes to this exact action on this case, in this conversation. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirmedByPerson"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
},
"confirmedByPerson": {
"type": "boolean",
"const": true,
"description": "Set to true only after the person has said yes to this exact action on this case, in this conversation."
}
}
}Use this when a draft’s facts need correcting or completing, for example after evictions_validate_case says what is missing. Input: the case `id` and only the fields to change; each one replaces the stored value, and an object such as `property` is replaced whole. Works only on a draft, and `ground` and `entryPoint` cannot change (create a new case instead). Do not use this on a submitted case (use evictions_send_case_message to tell the team what changed). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
| lease | object | The lease, when there is one. |
| ground | string | Why the case is brought: nonpayment of rent, a lease violation, or holdover (the tenant stayed after the lease ended). Cannot be changed later. |
| ledger | array | Rent charges and payments, for a nonpayment case. |
| parties | array | The plaintiff (the owner or manager) and each defendant (tenant). |
| freeText | string | Anything else the attorney should know. |
Use this when a draft looks complete, before asking the person to confirm its submission. Input: the case `id`. Runs the submission checks on a draft and returns each check’s result, with the reason when it does not pass, and whether all passed. Changes nothing. Do not use this to submit (use evictions_submit_case). Next: evictions_update_case to fill a gap, or the person’s yes and then evictions_submit_case. Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
}
}
}Use this when the person has decided to withdraw a case and stop it. Input: the case `id` and `confirmedByPerson`. A live case with an attorney already engaged goes on hold instead and is withdrawn once the attorney has confirmed that all work has stopped. With a live key this acts on a real case. Confirm with the person first, then pass `confirmedByPerson: true`. Do not use this to report that the tenant has paid or to ask a question (use evictions_send_case_message). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Needs the person’s account: sign-in or an API key.
| Argument | Type | Description |
|---|---|---|
| id* | string | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. |
| confirmedByPerson* | boolean | Set to true only after the person has said yes to this exact action on this case, in this conversation. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirmedByPerson"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
},
"confirmedByPerson": {
"type": "boolean",
"const": true,
"description": "Set to true only after the person has said yes to this exact action on this case, in this conversation."
}
}
}| violation | object | For a lease violation case. |
| entryPoint* | string | Where the case starts: `notice` (a notice to the tenant comes first), or `filing` when a notice was already served (then give `priorNotice`). Cannot be changed later. |
| landlordId | string | For a property manager: the id (lnd_...) of the landlord, the owner the case is for, from evictions_list_landlords. Its saved management agreement is added to the case as proof of authority. An archived landlord cannot be chosen, and a test-mode case cannot take one. |
| priorNotice | object | The notice already served, for a case that starts at filing. |
| attestations* | object | The person’s own statements about the case. Ask the person for each one; never fill them in yourself. On an update, send all of them again: this object replaces the one stored. |
| rentOwedCents | integer | The unpaid rent alone, without late fees or other charges; 0 when no rent is owed. A court filing states it as the rent due, and rent claimed is never more, in US cents (150000 is $1,500.00). |
| idempotencyKey | string | Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of a second case. Always pass one, and reuse it if you repeat the call. |
| amountOwedCents | integer | The total the tenant owes now, in US cents (150000 is $1,500.00). |
| plaintiffContact | object | How the court reaches the plaintiff (owner or manager): a Texas petition states the address and telephone. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"ground",
"entryPoint",
"property",
"parties",
"attestations"
],
"properties": {
"lease": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "The day the lease ends or ended, as YYYY-MM-DD."
},
"startDate": {
"type": "string",
"description": "The day the lease began, as YYYY-MM-DD."
},
"monthToMonth": {
"type": "boolean",
"description": "For a holdover in Texas: whether the tenancy is month to month."
},
"noticeMethods": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "In Georgia: the additional ways the rental agreement says a notice must be delivered, exactly as the lease states them, or the word `none`. The notice is posted on the door and states these methods too."
},
"monthlyRentCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The monthly rent, in US cents (150000 is $1,500.00)."
},
"noticePeriodDays": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "In Texas: the notice period, in days, the written lease sets for this notice; 3 when the lease sets none."
},
"terminationNoticeDate": {
"type": "string",
"description": "For a month-to-month holdover in Texas: the day written notice ending the tenancy was given, as YYYY-MM-DD."
}
},
"description": "The lease, when there is one."
},
"ground": {
"enum": [
"nonpayment",
"lease_violation",
"holdover"
],
"type": "string",
"description": "Why the case is brought: nonpayment of rent, a lease violation, or holdover (the tenant stayed after the lease ended). Cannot be changed later."
},
"ledger": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"type",
"amountCents"
],
"properties": {
"date": {
"type": "string",
"description": "The day of the charge or payment, as YYYY-MM-DD."
},
"kind": {
"enum": [
"rent",
"late_fee",
"utilities",
"other_fee",
"eviction_fee",
"attorney_fee",
"court_cost"
],
"type": "string",
"description": "For a charge only: what it is for. `other_fee` for any other charge; `eviction_fee`, `attorney_fee` or `court_cost` for a cost of the eviction itself, which no notice demands."
},
"memo": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "What it was for, such as \"October rent\"."
},
"type": {
"enum": [
"charge",
"payment"
],
"type": "string",
"description": "`charge` for rent or a fee owed, `payment` for money received."
},
"amountCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The amount, in US cents (150000 is $1,500.00)."
}
}
},
"maxItems": 1000,
"description": "Rent charges and payments, for a nonpayment case."
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full legal name of the person or company."
},
"role": {
"enum": [
"plaintiff",
"defendant"
],
"type": "string",
"description": "`plaintiff` for the owner or manager bringing the case, `defendant` for each tenant."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The party’s telephone number, if known. A Texas petition states the tenant’s."
},
"isEntity": {
"type": "boolean",
"description": "True when the party is a company rather than a person."
}
}
},
"maxItems": 20,
"description": "The plaintiff (the owner or manager) and each defendant (tenant)."
},
"freeText": {
"type": "string",
"maxLength": 5000,
"description": "Anything else the attorney should know."
},
"property": {
"type": "object",
"required": [
"line1",
"city",
"state",
"zip",
"ownerOfRecord"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^\\d{5}(-\\d{4})?$",
"description": "ZIP code: 5 digits, or ZIP+4 (12345-6789)."
},
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "City."
},
"unit": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Unit or apartment number, if any."
},
"line1": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Street address of the rental property."
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, for example TX; DC for the District of Columbia. Test keys use the fictional state ZZ."
},
"county": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "County, when known, as the US Census Bureau names it (\"Henry County\" or \"Henry\"); one the state does not have is refused."
},
"ownerOfRecord": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The owner of the property as on the deed: a person or a company."
}
},
"description": "The rental property and its owner of record."
},
"violation": {
"type": "object",
"required": [
"description",
"date"
],
"properties": {
"date": {
"type": "string",
"description": "The day it happened, as YYYY-MM-DD."
},
"description": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "What the tenant did that breaks the lease, in the person’s words."
}
},
"description": "For a lease violation case."
},
"entryPoint": {
"enum": [
"notice",
"filing"
],
"type": "string",
"description": "Where the case starts: `notice` (a notice to the tenant comes first), or `filing` when a notice was already served (then give `priorNotice`). Cannot be changed later."
},
"landlordId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "For a property manager: the id (lnd_...) of the landlord, the owner the case is for, from evictions_list_landlords. Its saved management agreement is added to the case as proof of authority. An archived landlord cannot be chosen, and a test-mode case cannot take one."
},
"priorNotice": {
"type": "object",
"required": [
"servedDate",
"method",
"periodDays"
],
"properties": {
"type": {
"enum": [
"notice_to_vacate",
"notice_to_pay_rent_or_vacate",
"pay_or_quit",
"cure_or_quit"
],
"type": "string",
"description": "Which notice it was, as written on it: a notice to vacate, a notice to pay rent or vacate, pay or quit, or cure or quit."
},
"method": {
"enum": [
"personal",
"substitute",
"posting",
"certified_mail",
"first_class_mail"
],
"type": "string",
"description": "How it was served: handed to the tenant, left with another adult, posted on the door, or sent by certified or first-class mail."
},
"periodDays": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "How many days the notice gave the tenant."
},
"servedDate": {
"type": "string",
"description": "The day the notice was served, as YYYY-MM-DD."
},
"sealedEnvelope": {
"type": "boolean",
"description": "In Georgia: whether the notice was posted in a sealed envelope on the door of the premises, as the person states it. The filing says so; a posted notice answered false there does not pass the prior-notice check."
}
},
"description": "The notice already served, for a case that starts at filing."
},
"attestations": {
"type": "object",
"properties": {
"authority": {
"type": "boolean",
"description": "The person owns the property or is authorized to act for the owner in this eviction."
},
"subsidized": {
"type": "boolean",
"description": "Whether the tenant lives in subsidized housing or receives rental assistance, such as a housing voucher."
},
"caresCovered": {
"type": "boolean",
"description": "Whether the property is covered by the federal CARES Act."
},
"servicemember": {
"enum": [
"no",
"yes",
"unknown"
],
"type": "string",
"description": "Whether the tenant is on active military duty; `unknown` is an accepted answer."
},
"notRetaliatory": {
"type": "boolean",
"description": "The eviction is not in response to the tenant making a complaint, reporting a problem to an authority, or using a legal right."
},
"notDiscriminatory": {
"type": "boolean",
"description": "The eviction is not based on who the tenant is, such as their race, religion, sex, national origin, disability or family status."
},
"lateBeforeNoticeMonth": {
"type": "boolean",
"description": "For nonpayment: whether the tenant was late or behind on rent before the month the notice was given. A Texas petition states it."
}
},
"description": "The person’s own statements about the case. Ask the person for each one; never fill them in yourself. On an update, send all of them again: this object replaces the one stored."
},
"rentOwedCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The unpaid rent alone, without late fees or other charges; 0 when no rent is owed. A court filing states it as the rent due, and rent claimed is never more, in US cents (150000 is $1,500.00)."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\x21-\\x7E]+$",
"maxLength": 255,
"minLength": 1,
"description": "Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of a second case. Always pass one, and reuse it if you repeat the call."
},
"amountOwedCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The total the tenant owes now, in US cents (150000 is $1,500.00)."
},
"plaintiffContact": {
"type": "object",
"required": [
"address",
"phone"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "The plaintiff’s email address, if they want it on the filing."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The plaintiff’s telephone number."
},
"address": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The plaintiff’s mailing address, on one line."
}
},
"description": "How the court reaches the plaintiff (owner or manager): a Texas petition states the address and telephone."
}
}
}| idempotencyKey | string | Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of the file sent twice. Always pass one, and reuse it if you repeat the call. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"filename",
"contentBase64"
],
"properties": {
"note": {
"type": "string",
"maxLength": 500,
"description": "A short note the person sees with the file, such as which property or tenant it is about."
},
"purpose": {
"enum": [
"lease",
"ledger",
"correspondence",
"other"
],
"type": "string",
"description": "What the file is, if you know: the lease, the tenant ledger, correspondence (emails or messages with the tenant), or other. Left out, it is guessed from the file’s name, and the person can change it."
},
"filename": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The file’s name, such as lease.pdf. Its type is read from the file itself, not from the name."
},
"contentBase64": {
"type": "string",
"maxLength": 950000,
"minLength": 1,
"description": "The file itself, base64-encoded: a PDF, JPEG or PNG of about 700 KB at most (950,000 base64 characters). A larger file, up to 4 MB, goes through the API directly."
},
"idempotencyKey": {
"type": "string",
"pattern": "^[\\x21-\\x7E]+$",
"maxLength": 255,
"minLength": 1,
"description": "Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of the file sent twice. Always pass one, and reuse it if you repeat the call."
}
}
}| property |
| object |
| The rental property and its owner of record. |
| violation | object | For a lease violation case. |
| entryPoint | string | Where the case starts: `notice` (a notice to the tenant comes first), or `filing` when a notice was already served (then give `priorNotice`). Cannot be changed later. |
| priorNotice | object | The notice already served, for a case that starts at filing. |
| attestations | object | The person’s own statements about the case. Ask the person for each one; never fill them in yourself. On an update, send all of them again: this object replaces the one stored. |
| rentOwedCents | integer | The unpaid rent alone, without late fees or other charges; 0 when no rent is owed. A court filing states it as the rent due, and rent claimed is never more, in US cents (150000 is $1,500.00). |
| amountOwedCents | integer | The total the tenant owes now, in US cents (150000 is $1,500.00). |
| plaintiffContact | object | How the court reaches the plaintiff (owner or manager): a Texas petition states the address and telephone. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,100}$",
"description": "The case id (case_...), as returned by evictions_create_case or evictions_list_cases."
},
"lease": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "The day the lease ends or ended, as YYYY-MM-DD."
},
"startDate": {
"type": "string",
"description": "The day the lease began, as YYYY-MM-DD."
},
"monthToMonth": {
"type": "boolean",
"description": "For a holdover in Texas: whether the tenancy is month to month."
},
"noticeMethods": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "In Georgia: the additional ways the rental agreement says a notice must be delivered, exactly as the lease states them, or the word `none`. The notice is posted on the door and states these methods too."
},
"monthlyRentCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The monthly rent, in US cents (150000 is $1,500.00)."
},
"noticePeriodDays": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "In Texas: the notice period, in days, the written lease sets for this notice; 3 when the lease sets none."
},
"terminationNoticeDate": {
"type": "string",
"description": "For a month-to-month holdover in Texas: the day written notice ending the tenancy was given, as YYYY-MM-DD."
}
},
"description": "The lease, when there is one."
},
"ground": {
"enum": [
"nonpayment",
"lease_violation",
"holdover"
],
"type": "string",
"description": "Why the case is brought: nonpayment of rent, a lease violation, or holdover (the tenant stayed after the lease ended). Cannot be changed later."
},
"ledger": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"type",
"amountCents"
],
"properties": {
"date": {
"type": "string",
"description": "The day of the charge or payment, as YYYY-MM-DD."
},
"kind": {
"enum": [
"rent",
"late_fee",
"utilities",
"other_fee",
"eviction_fee",
"attorney_fee",
"court_cost"
],
"type": "string",
"description": "For a charge only: what it is for. `other_fee` for any other charge; `eviction_fee`, `attorney_fee` or `court_cost` for a cost of the eviction itself, which no notice demands."
},
"memo": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "What it was for, such as \"October rent\"."
},
"type": {
"enum": [
"charge",
"payment"
],
"type": "string",
"description": "`charge` for rent or a fee owed, `payment` for money received."
},
"amountCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The amount, in US cents (150000 is $1,500.00)."
}
}
},
"maxItems": 1000,
"description": "Rent charges and payments, for a nonpayment case."
},
"parties": {
"type": "array",
"items": {
"type": "object",
"required": [
"role",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full legal name of the person or company."
},
"role": {
"enum": [
"plaintiff",
"defendant"
],
"type": "string",
"description": "`plaintiff` for the owner or manager bringing the case, `defendant` for each tenant."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The party’s telephone number, if known. A Texas petition states the tenant’s."
},
"isEntity": {
"type": "boolean",
"description": "True when the party is a company rather than a person."
}
}
},
"maxItems": 20,
"description": "The plaintiff (the owner or manager) and each defendant (tenant)."
},
"freeText": {
"type": "string",
"maxLength": 5000,
"description": "Anything else the attorney should know."
},
"property": {
"type": "object",
"required": [
"line1",
"city",
"state",
"zip",
"ownerOfRecord"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^\\d{5}(-\\d{4})?$",
"description": "ZIP code: 5 digits, or ZIP+4 (12345-6789)."
},
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "City."
},
"unit": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Unit or apartment number, if any."
},
"line1": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Street address of the rental property."
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, for example TX; DC for the District of Columbia. Test keys use the fictional state ZZ."
},
"county": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "County, when known, as the US Census Bureau names it (\"Henry County\" or \"Henry\"); one the state does not have is refused."
},
"ownerOfRecord": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The owner of the property as on the deed: a person or a company."
}
},
"description": "The rental property and its owner of record."
},
"violation": {
"type": "object",
"required": [
"description",
"date"
],
"properties": {
"date": {
"type": "string",
"description": "The day it happened, as YYYY-MM-DD."
},
"description": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "What the tenant did that breaks the lease, in the person’s words."
}
},
"description": "For a lease violation case."
},
"entryPoint": {
"enum": [
"notice",
"filing"
],
"type": "string",
"description": "Where the case starts: `notice` (a notice to the tenant comes first), or `filing` when a notice was already served (then give `priorNotice`). Cannot be changed later."
},
"priorNotice": {
"type": "object",
"required": [
"servedDate",
"method",
"periodDays"
],
"properties": {
"type": {
"enum": [
"notice_to_vacate",
"notice_to_pay_rent_or_vacate",
"pay_or_quit",
"cure_or_quit"
],
"type": "string",
"description": "Which notice it was, as written on it: a notice to vacate, a notice to pay rent or vacate, pay or quit, or cure or quit."
},
"method": {
"enum": [
"personal",
"substitute",
"posting",
"certified_mail",
"first_class_mail"
],
"type": "string",
"description": "How it was served: handed to the tenant, left with another adult, posted on the door, or sent by certified or first-class mail."
},
"periodDays": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "How many days the notice gave the tenant."
},
"servedDate": {
"type": "string",
"description": "The day the notice was served, as YYYY-MM-DD."
},
"sealedEnvelope": {
"type": "boolean",
"description": "In Georgia: whether the notice was posted in a sealed envelope on the door of the premises, as the person states it. The filing says so; a posted notice answered false there does not pass the prior-notice check."
}
},
"description": "The notice already served, for a case that starts at filing."
},
"attestations": {
"type": "object",
"properties": {
"authority": {
"type": "boolean",
"description": "The person owns the property or is authorized to act for the owner in this eviction."
},
"subsidized": {
"type": "boolean",
"description": "Whether the tenant lives in subsidized housing or receives rental assistance, such as a housing voucher."
},
"caresCovered": {
"type": "boolean",
"description": "Whether the property is covered by the federal CARES Act."
},
"servicemember": {
"enum": [
"no",
"yes",
"unknown"
],
"type": "string",
"description": "Whether the tenant is on active military duty; `unknown` is an accepted answer."
},
"notRetaliatory": {
"type": "boolean",
"description": "The eviction is not in response to the tenant making a complaint, reporting a problem to an authority, or using a legal right."
},
"notDiscriminatory": {
"type": "boolean",
"description": "The eviction is not based on who the tenant is, such as their race, religion, sex, national origin, disability or family status."
},
"lateBeforeNoticeMonth": {
"type": "boolean",
"description": "For nonpayment: whether the tenant was late or behind on rent before the month the notice was given. A Texas petition states it."
}
},
"description": "The person’s own statements about the case. Ask the person for each one; never fill them in yourself. On an update, send all of them again: this object replaces the one stored."
},
"rentOwedCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The unpaid rent alone, without late fees or other charges; 0 when no rent is owed. A court filing states it as the rent due, and rent claimed is never more, in US cents (150000 is $1,500.00)."
},
"amountOwedCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The total the tenant owes now, in US cents (150000 is $1,500.00)."
},
"plaintiffContact": {
"type": "object",
"required": [
"address",
"phone"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "The plaintiff’s email address, if they want it on the filing."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The plaintiff’s telephone number."
},
"address": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The plaintiff’s mailing address, on one line."
}
},
"description": "How the court reaches the plaintiff (owner or manager): a Texas petition states the address and telephone."
}
}
}