Evictions API

Customer endpoints

Called with an organization API key (or, from the website, a signed-in session). Everything you need to create, check, submit and follow a case.

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/jurisdictions/resolve

Whether a jurisdiction is served, and its notice rules

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
statequerystringYesTwo-letter state code. With a test key, ZZ is the fictional test state.
countyquerystringNoCounty name, to include county-level rules.
cityquerystringNoCity name, to include city-level rules.

Responses

StatusMeaningBody
200Served status, `handling`, jurisdiction ids and the grounds. With a live key every US state and DC is served, with the `handling` a case created there gets (`"agent_filed"` where `fullService` is true, `"attorney_direct"` elsewhere), `action: null` and, for each ground, `notice: null` and the facts intake requires (`requiredFacts`) and, where `fullService` is true, the facts that place's documents ask for beyond them (`documentFacts`: `notice` and `filing`, by where the case starts, and `conditional`, facts asked for only when another holds (with `past: true`, when that fact is a date before today, such as a lease end date that has passed), `ledgerItemised`, where the place's documents itemise the ledger by kind of charge (`notice`: the notice demands only what is past due on its date; `filing`: the filing states the amounts by kind), `claimKinds`, the kinds of charge besides rent (`late_fee`, `utilities`, `other_fee`) a full-service money claim may include there, each from the ledger's own unpaid charges of that kind and sent as `managedContext.relief.items` with `leaseProvidesCharges: true`, and `defaults`, the pack's own default where a fact has one). They apply to a full-service case: ask an attorney-path case for the intake facts alone; anything else is `served: false`. With a test key (`handling: "automated"`) the fictional test state answers with its notice rules for each ground. `fullService` says whether a case created here with `service: "full"` is handled by us as your agent (no attorney reviews it); where it is false, a managed-service request answers 409 `service_unavailable` with its operational reason. This does not establish a legal requirement for counsel. `county` may be written as the US Census Bureau lists it or by its short name, in any case ("Henry County", "henry"); a county the state does not have answers 400 `invalid_request`. `court` is the court the place's rules say a case goes to, with the county ("Magistrate court of Henry County"), or `null` where no rule pack covers the place. `courts` lists, where `fullService` is true, the courts a full-service case's `managedContext.courtId` may name, each with the `forums` its `managedContext.forum` may name; it is empty otherwise.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/jurisdictions/resolve
curl "https://api.evictionsapi.com/v1/jurisdictions/resolve?state=ZZ" \
  -H "Authorization: Bearer eak_test_..."

POST /v1/geo/county

Find the county of a street address, from the US Census geocoder. The address goes in the body, never the URL; the unit is not passed on, and nothing is stored. When the county cannot be found (no match, a match in another state or in more than one county, or the geocoder failing or taking over 5 seconds) the answer is `{ "county": null }`, never an error. At most 60 an hour per organization (429 `rate_limited`)

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
line1stringYes1 to 200 characters.
unitstringNo1 to 50 characters.
citystringNo1 to 100 characters.
statestringYesPattern ^[A-Za-z]{2}$.
zipstringNoPattern ^\d{5}(-\d{4})?$.

Responses

StatusMeaningBody
200The address as sent, with `city` and `zip` filled in from the geocoder where they were missing, and the county as a case stores it: its short name in the US Census Bureau's county list, without the word "County" or "Parish" (an independent city keeps "City", for example "Baltimore City"); or `{ "county": null }`, also when the geocoder names a county the list does not have.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 POST /v1/geo/county
curl -X POST https://api.evictionsapi.com/v1/geo/county \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "line1": "73 W Flagler St",
  "city": "Miami",
  "state": "FL",
  "zip": "33130"
}'

GET /v1/intake/address

The organization's email intake address, `cases+<token>@<domain>`: email sent to it by a member of the organization whose address is confirmed puts its attachments and its text in the intake inbox. Made on the first call, the same afterwards. Live only: a test key answers 422 `live_only`

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The address.{ address: string }
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
404`not_configured`: email intake is not set up on this server.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/intake/address
curl https://api.evictionsapi.com/v1/intake/address \
  -H "Authorization: Bearer eak_test_..."

POST /v1/intake/address/rotate

Replace the organization's email intake address with a new one. Email sent to the old address is no longer received. A signed-in owner only (an API key answers 403). Live only

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
200The new address.{ address: string }
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
404`not_configured`: email intake is not set up on this server.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/intake/address/rotate
curl -X POST https://api.evictionsapi.com/v1/intake/address/rotate \
  -H "Authorization: Bearer ess_..."

GET /v1/integrations

List the organization's stored property-management connections (Buildium, DoorLoop), without their credentials. A signed-in session in live mode only: an API key answers 403

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
200The connections.{ items: PmsConnection[] }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.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
422`live_only`: a session in test mode.Error

Example

curl example for GET /v1/integrations
curl https://api.evictionsapi.com/v1/integrations \
  -H "Authorization: Bearer ess_..."

POST /v1/integrations/{system}/connect

Connect Buildium (`credentials: { clientId, clientSecret }`) or DoorLoop (`credentials: { token }`) for the organization. The key is checked with one read-only call to the system, then stored encrypted, replacing any earlier one; it is never returned. An owner's signed-in session in live mode only

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
systempathstringYes—

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
labelstringNo1 to 100 characters. Pattern ^[^\u0000-\u001f\u007f]*$.
credentialsanyYes—

Responses

StatusMeaningBody
201The stored connection.PmsConnection
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.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
422`invalid_credentials`: the system refused the key; nothing is stored. `live_only`: a session in test mode.Error
429`rate_limited`: at most 60 connects and searches an hour per organization, counted together. `Retry-After` gives the seconds to wait.Error
502`pms_unavailable`: the system did not answer as expected; nothing is stored.Error
503`pms_busy`: the system asked us to wait; nothing is stored.Error

Example

curl example for POST /v1/integrations/{system}/connect
curl -X POST https://api.evictionsapi.com/v1/integrations/system_.../connect \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Main portfolio",
  "credentials": {
    "clientId": "your-buildium-client-id",
    "clientSecret": "your-buildium-client-secret"
  }
}'

DELETE /v1/integrations/{system}

Disconnect a property-management system: its stored key is deleted. An owner's signed-in session in live mode only

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
systempathstringYes—

Responses

StatusMeaningBody
204The connection is deleted.—
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.Error
404`not_connected`: there is no connection to delete.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
422`live_only`: a session in test mode.Error

Example

curl example for DELETE /v1/integrations/{system}
curl -X DELETE https://api.evictionsapi.com/v1/integrations/system_... \
  -H "Authorization: Bearer ess_..."

POST /v1/integrations/{system}/leases

Search the connected system's leases: by tenant name in Buildium, by lease name (which names its unit and tenants) in DoorLoop. At most 20 leases. A signed-in session in live mode only

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
systempathstringYes—

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
searchstringYes2 to 100 characters.

Responses

StatusMeaningBody
200The leases found.{ items: LeaseMatch[] }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.Error
404`not_connected`: the organization has not connected this system. `lease_not_found` (pull): the system has no such lease for the stored key.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
422`live_only`: a session in test mode.Error
429`rate_limited`: at most 60 connects and searches an hour per organization, counted together. `Retry-After` gives the seconds to wait.Error
502`pms_refused`: the system refused the stored key (connect it again); `pms_unavailable`: the system did not answer as expected.Error
503`pms_busy`: the system asked us to wait.Error

Example

curl example for POST /v1/integrations/{system}/leases
curl -X POST https://api.evictionsapi.com/v1/integrations/system_.../leases \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "search": "Terry Tenant" }'

POST /v1/integrations/{system}/pull

Read one lease from the connected system as suggested answers for a new case: the address, the tenants, the lease dates and rent, the ledger and the system's balance, and its lease PDF when it has one. A part the system no longer has (a tenant, the unit) is left out. Nothing is stored or filed by this. A signed-in session in live mode only

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
systempathstringYes—

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
leaseIdstringYesPattern ^[A-Za-z0-9]{1,40}$.

Responses

StatusMeaningBody
200The lease's suggested answers.PmsPull
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.Error
404`not_connected`: the organization has not connected this system. `lease_not_found` (pull): the system has no such lease for the stored key.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
422`live_only`: a session in test mode.Error
429`rate_limited`: at most 10 pulls an hour per organization. `Retry-After` gives the seconds to wait.Error
502`pms_refused`: the system refused the stored key (connect it again); `pms_unavailable`: the system did not answer as expected.Error
503`pms_busy`: the system asked us to wait.Error
504`pms_timeout`: the system took more than 40 seconds over the whole pull. It does not count against the hourly limit.Error

Example

curl example for POST /v1/integrations/{system}/pull
curl -X POST https://api.evictionsapi.com/v1/integrations/system_.../pull \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "leaseId": "2101" }'

GET /v1/intake/files

List the files waiting in the organization's intake inbox, oldest first: files the customer already has (a lease, a ledger, an email) kept until a case is started. Live only: a test key answers 422 `live_only`

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The waiting files, without their contents.{ items: IntakeFile[] }
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/intake/files
curl https://api.evictionsapi.com/v1/intake/files \
  -H "Authorization: Bearer eak_test_..."

POST /v1/intake/files

Keep a file in the organization's intake inbox until a case is started: a PDF, JPEG or PNG of at most 4 MB, decided by its contents. The inbox holds 50 waiting files (409 `inbox_full`), each for 30 days. Live only: a test key answers 422 `live_only`

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
filenamestringYes1 to 255 characters.
purposestringNoOne of: "lease", "ledger", "correspondence", "other".
notestringNo1 to 500 characters.
contentBase64stringYes1 to 5592408 characters.

Responses

StatusMeaningBody
201The stored file, without its name or note: the list gives them back while the file waits.{ id: string, source: string, contentType: string, purposeGuess: string, receivedAt: string, expiresAt: string }
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
409`inbox_full`: the inbox already holds 50 waiting files. Start a case from them, or remove some, and send again.Error
413`too_large`: the file is over 4 MB.Error
415`unsupported_media_type`: the file is not a PDF, JPEG or PNG, decided from its contents.Error
422`live_only`: a test key; the intake inbox is live only.Error
429`rate_limited`: at most 60 files an hour per organization. `Retry-After` gives the seconds to wait.Error

Example

curl example for POST /v1/intake/files
curl -X POST https://api.evictionsapi.com/v1/intake/files \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "filename": "lease.pdf",
  "note": "Lease for unit 2B",
  "contentBase64": "JVBERi0xLjcK"
}'

POST /v1/extract

Read a lease (PDF, JPEG or PNG, at most 4 MB and, for a PDF, 40 pages, as base64) with an AI service (Claude Haiku 4.5 through OpenRouter) and answer the facts the new-case form takes. For a file the free reading on the device could not read. With `kind: "correspondence"` and `files` (1 to 10 messages with the tenant: PDF, JPEG, PNG, plain text `text/plain`, or a saved email `message/rfc822` (`.eml`, at most 1 MB, turned into its text before it is sent); 8 MB, 40 PDF pages and 200,000 characters of text in all), it drafts what happened for a lease-violation case (`violationDescription`, `violationDate`): a draft for the person to read and correct, never a checked answer. One request counts once against the hourly limit, whatever the number of files. With `kind: "ledger"` and one `file` (a tenant ledger PDF, at most 4 MB and 40 pages), it answers the ledger's rows (`rows`, each `{ date, type: "charge" | "payment", amountCents, memo }`, at most 500, in the order printed) a balance brought forward from before them (`openingBalanceCents`, null when none) and the ending balance the ledger states (`endingBalanceCents`, null when it states none), for the caller to check: the balance brought forward and the rows should add up to the ending balance, and the website fills in nothing when they do not. A row dated after today is left out. The files are sent to OpenRouter only for this one reading, under fixed names (the `name` you send is never passed on), on endpoints that keep no data; nothing is stored and nothing of the files or the answer is logged. Every answer is a suggestion for a person to check: a fact the reading is unsure of is left out, never guessed. When the service refuses, fails or takes over 30 seconds, the answer is empty (`{ "suggestions": {}, "confidence": {} }`, or for a ledger `{ "rows": [], "openingBalanceCents": null, "endingBalanceCents": null }`), never an error. For now only the signed-in app and test keys can use it: a live API key answers 503 `extract_unavailable`. At most 20 an hour per organization (429 `rate_limited`); 503 `extract_unavailable` when the server has no AI service set

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

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

When kind is "lease"

NameTypeRequiredDescription
kindstringYesAlways "lease".
fileobjectYes—
file.namestringYes1 to 255 characters.
file.contentTypestringYes1 to 100 characters.
file.contentBase64stringYesAt least 1 characters.

When kind is "correspondence"

NameTypeRequiredDescription
kindstringYesAlways "correspondence".
filesarray of objectYes1 to 10 items.
files[].namestringYes1 to 255 characters.
files[].contentTypestringYes1 to 100 characters.
files[].contentBase64stringYesAt least 1 characters.

When kind is "ledger"

NameTypeRequiredDescription
kindstringYesAlways "ledger".
fileobjectYes—
file.namestringYes1 to 255 characters.
file.contentTypestringYes1 to 100 characters.
file.contentBase64stringYesAt least 1 characters.

Responses

StatusMeaningBody
200The answers found, in the same shape as the website's lease reading: each a `{ value, source: "lease_file" }` (`source: "messages"` for the messages' draft), and how sure the reading is of each (`high` or `medium`). Dates are `YYYY-MM-DD`, `monthlyRent` is dollars with cents ("1450.00"), `noticePeriod` is whole days ("3"), `state` is the two-letter code; `parties` lists the landlord (`plaintiff`) and the tenants (`defendant`). From messages: `violationDescription` (a few plain sentences, at most 2,000 characters) and `violationDate` (never later than today).object
400The request is invalid (`invalid_request`): `kind` must be `lease` or `ledger` with one `file`, or `correspondence` with `files` (1 to 10), and each file must have exactly `name`, `contentType` and `contentBase64` (valid base64).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
413`payload_too_large`: a file is over 4 MB, a PDF has more than 40 pages, a text or `.eml` message is over 1 MB, or the messages together are over 8 MB, 40 PDF pages or 200,000 characters of text (the body itself may be at most 14 MB).Error
415`unsupported_media_type`: a file is not a PDF, JPEG or PNG (or, for a message, plain UTF-8 text or a `.eml` email; for a ledger, only a PDF), `contentType` is not the type of its bytes, a `.eml` file is not an email, or a PDF's pages could not be counted.Error
422The case did not pass a check.Error
429`rate_limited`: the organization has made 20 requests this hour (the server may set another number). Every request counts, a refused one too: the limit is checked before any file is read. `Retry-After` gives the seconds to wait.Error
503`extract_unavailable`: reading files with the AI service is not set up on this server, or is not open to live API keys yet (only the signed-in app and test keys can use it for now). Fill in the form by hand, or read the file on the device.Error

Example

curl example for POST /v1/extract
curl -X POST https://api.evictionsapi.com/v1/extract \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "lease",
  "file": {
    "name": "lease.pdf",
    "contentType": "application/pdf",
    "contentBase64": "JVBERi0xLjcKJSVFT0YK"
  }
}'

GET /v1/intake/files/{id}

Download a waiting file of the intake inbox. A file moved onto a case is downloaded as that case's document instead (404 here). Live only

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe intake file id.

Responses

StatusMeaningBody
200The file's bytes, with the stored `Content-Type`: `application/pdf`, `image/jpeg` or `image/png`, or `text/plain; charset=utf-8` for the text of a forwarded email, as an attachment.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
422The case did not pass a check.Error

Example

curl example for GET /v1/intake/files/{id}
curl https://api.evictionsapi.com/v1/intake/files/intake_... \
  -H "Authorization: Bearer eak_test_..." \
  -o document.pdf

DELETE /v1/intake/files/{id}

Delete a waiting file of the intake inbox. Live only

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe intake file id.

Responses

StatusMeaningBody
204The file is deleted.—
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 DELETE /v1/intake/files/{id}
curl -X DELETE https://api.evictionsapi.com/v1/intake/files/intake_... \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases

Create a draft case. For a live case the property must be in a US state or DC (422 `unsupported_state`) and the case takes the full-service path (we act as your agent, no attorney reviews the case) wherever that path is open for the property; elsewhere it is an attorney-direct case. The case's `handling` says which. `service` is not needed for a live case: `"attorney"` selects nothing, and `"full"` where the path is not open answers 409 `service_unavailable` without creating a different service. A test case takes the full-service path only with `service: "full"`

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
groundstringYesOne of: "nonpayment", "lease_violation", "holdover".
entryPointstringYesOne of: "notice", "filing".
propertyobjectYes—
property.line1stringYes1 to 200 characters.
property.unitstringNo1 to 50 characters.
property.citystringYes1 to 100 characters.
property.countystringNoThe county, as the US Census Bureau lists it or by its short name, in any case ("Henry County", "Henry", "henry"). It is stored by its short name ("Henry"); a county the state does not have is refused (400 `invalid_request`). 1 to 100 characters.
property.statestringYesPattern ^[A-Za-z]{2}$.
property.zipstringYesPattern ^\d{5}(-\d{4})?$.
property.ownerOfRecordstringYes1 to 200 characters.
partiesarray of objectYesUp to 20 items.
parties[].rolestringYesOne of: "plaintiff", "defendant".
parties[].namestringYes1 to 200 characters.
parties[].isEntitybooleanNo—
parties[].phonestringNo1 to 40 characters.
leaseobjectNo—
lease.startDatestringNo—
lease.endDatestringNo—
lease.monthlyRentCentsintegerNo0 or more.
lease.noticePeriodDaysintegerNo1 to 365.
lease.monthToMonthbooleanNo—
lease.terminationNoticeDatestringNo—
lease.noticeMethodsstringNoThe additional ways the rental agreement says a notice must be delivered, exactly as the lease states them, or the word `none`. Asked for where a place's notice states them (Georgia): the notice is posted on the door and says it is also delivered by these methods, or that the rental agreement provides none. 1 to 500 characters.
ledgerarray of objectNoUp to 1000 items.
ledger[].datestringIf ledger is sent—
ledger[].typestringIf ledger is sentOne of: "charge", "payment".
ledger[].amountCentsintegerIf ledger is sent0 or more.
ledger[].memostringNo1 to 500 characters.
ledger[].kindstringNoWhat a charge is for: `rent`, `late_fee`, `utilities`, `other_fee` (any other charge), or a cost of the eviction itself: `eviction_fee`, `attorney_fee` or `court_cost`. A charge only; a payment has none. Where every charge has a kind, a place's documents itemise what is past due by kind (Georgia's notice demands only charges dated on or before its date, and never an `eviction_fee`, `attorney_fee` or `court_cost`, which are not owed before filing); a charge without a kind is accepted, except where the place's documents itemise the ledger by kind (Georgia full-service nonpayment cases today), where every charge must have a kind at submission. One of: "rent", "late_fee", "utilities", "other_fee", "eviction_fee", "attorney_fee", "court_cost".
amountOwedCentsintegerNo0 or more.
ledgerPaymentsAppliedstringNoHow the payments on the ledger are applied to its charges. Absent or `oldest_first`: each payment goes to the oldest unpaid charge, whatever it is for. `rent_first`: every payment goes to rent before any other charge, for a lease that says so. It decides the rent past due and the other amounts a place's documents itemise from the ledger, and the most `rentOwedCents` may be there. One of: "oldest_first", "rent_first".
rentOwedCentsintegerNo0 or more.
violationobjectNo—
violation.descriptionstringIf violation is sent1 to 5000 characters.
violation.datestringIf violation is sent—
attestationsobjectYes—
attestations.authoritybooleanNo—
attestations.notRetaliatorybooleanNo—
attestations.notDiscriminatorybooleanNo—
attestations.servicememberstringNoOne of: "no", "yes", "unknown".
attestations.caresCoveredbooleanNo—
attestations.subsidizedbooleanNo—
attestations.lateBeforeNoticeMonthbooleanNo—
plaintiffContactobjectNo—
plaintiffContact.addressstringIf plaintiffContact is sent1 to 500 characters.
plaintiffContact.phonestringIf plaintiffContact is sent1 to 40 characters.
plaintiffContact.emailstringNoFormat: email. Up to 254 characters. 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,}$.
priorNoticeobjectNo—
priorNotice.servedDatestringIf priorNotice is sent—
priorNotice.methodstringIf priorNotice is sentOne of: "personal", "substitute", "posting", "certified_mail", "first_class_mail", "text_message", "email".
priorNotice.periodDaysintegerIf priorNotice is sent1 to 365.
priorNotice.typestringNoOne of: "notice_to_vacate", "notice_to_pay_rent_or_vacate", "pay_or_quit", "cure_or_quit".
priorNotice.sealedEnvelopebooleanNoWhether the notice already served was posted in a sealed envelope on the door of the premises, as the person states it. Asked for where a place's filing states it (Georgia): the filing says so, and a posted notice answered `false` there does not pass the prior-notice check.
managedContextobjectNo—
managedContext.plaintiffTypestringIf managedContext is sentOne of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other".
managedContext.courtIdstringIf managedContext is sent1 to 200 characters.
managedContext.forumstringIf managedContext is sent1 to 100 characters.
managedContext.residentialbooleanIf managedContext is sent—
managedContext.phasestringIf managedContext is sentOne of: "initial", "contested", "jury", "appeal", "post_judgment".
managedContext.reliefobjectIf managedContext is sent—
managedContext.relief.possessionbooleanIf managedContext is sent—
managedContext.relief.moneyCentsintegerIf managedContext is sent0 or more.
managedContext.relief.itemsobjectNo—
managedContext.relief.items.rentCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.items.lateFeesCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.items.utilitiesCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.items.otherCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.leaseProvidesChargesbooleanNoAlways true.
managedContext.actorsarray of objectIf managedContext is sentUp to 30 items.
managedContext.actors[].idstringIf managedContext is sent1 to 100 characters.
managedContext.actors[].namestringNo1 to 200 characters.
managedContext.actors[].relationshipstringIf managedContext is sentOne of: "plaintiff_self", "plaintiff_officer", "plaintiff_employee", "property_manager", "platform_employee", "friend_relative", "counsel", "court_officer", "process_server".
managedContext.actors[].actionsarray of stringIf managedContext is sentAt least 1 items.
freeTextstringNoUp to 5000 characters.
sourcesobjectNo—
servicestringNoOne of: "full", "attorney".
managedFactsobjectNo—
managedFacts.declarationsarray of objectNo1 to 7 items.
managedFacts.declarations[].contextobjectIf managedFacts.declarations is sent—
managedFacts.declarations[].context.plaintiffTypestringIf managedFacts.declarations is sentOne of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other".
managedFacts.declarations[].context.courtIdstringIf managedFacts.declarations is sent1 to 200 characters.
managedFacts.declarations[].context.forumstringIf managedFacts.declarations is sent1 to 100 characters.
managedFacts.declarations[].context.residentialbooleanIf managedFacts.declarations is sent—
managedFacts.declarations[].context.phasestringIf managedFacts.declarations is sentOne of: "initial", "contested", "jury", "appeal", "post_judgment".
managedFacts.declarations[].context.reliefobjectIf managedFacts.declarations is sent—
managedFacts.declarations[].context.relief.possessionbooleanIf managedFacts.declarations is sent—
managedFacts.declarations[].context.relief.moneyCentsintegerIf managedFacts.declarations is sent0 or more.
managedFacts.declarations[].context.relief.itemsobjectNo—
managedFacts.declarations[].context.relief.items.rentCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.items.lateFeesCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.items.utilitiesCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.items.otherCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.leaseProvidesChargesbooleanNoAlways true.
managedFacts.declarations[].context.actorsarray of objectIf managedFacts.declarations is sentUp to 30 items.
managedFacts.declarations[].context.actors[].idstringIf managedFacts.declarations is sent1 to 100 characters.
managedFacts.declarations[].context.actors[].namestringNo1 to 200 characters.
managedFacts.declarations[].context.actors[].relationshipstringIf managedFacts.declarations is sentOne of: "plaintiff_self", "plaintiff_officer", "plaintiff_employee", "property_manager", "platform_employee", "friend_relative", "counsel", "court_officer", "process_server".
managedFacts.declarations[].context.actors[].actionsarray of stringIf managedFacts.declarations is sentAt least 1 items.
managedFacts.declarations[].sourcestringIf managedFacts.declarations is sentOne of: "customer", "suggestion".
managedFacts.declarations[].provenanceobjectNo—
managedFacts.declarations[].provenance.sourcestringIf managedFacts.declarations[].provenance is sentOne of: "lease_file", "buildium", "doorloop", "address", "ledger_file", "messages", "draft_file", "agent".
managedFacts.declarations[].provenance.confidencenumberNo0 to 1.
managedFacts.declarations[].provenance.labelstringIf managedFacts.declarations[].provenance is sent1 to 200 characters.
managedFacts.dismissedarray of stringNo1 to 7 items.
landlordIdstringNoThe owner the organization acts for on this case: the id of one of its active landlords (`GET /v1/landlords`). On a draft only. Choosing one adds its current management agreement to the case as an authority document, unless the case already has that file; changing it later adds the new landlord's agreement and removes nothing. Live cases only: landlords are real owners, so a test case never takes one. 422 `landlord_not_found` for a landlord that is not one of the organization's active landlords, and for any landlord on a test case. 1 to 64 characters. Pattern ^[A-Za-z0-9_-]+$.

Responses

StatusMeaningBody
201The draft case.Case
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/cases
curl -X POST https://api.evictionsapi.com/v1/cases \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "ground": "nonpayment",
  "entryPoint": "notice",
  "property": {
    "line1": "1 Main St",
    "city": "Testville",
    "state": "ZZ",
    "zip": "00000",
    "ownerOfRecord": "Pat Landlord"
  },
  "parties": [
    { "role": "plaintiff", "name": "Pat Landlord" },
    { "role": "defendant", "name": "Terry Tenant" }
  ],
  "lease": { "startDate": "2025-01-01", "monthlyRentCents": 150000 },
  "ledger": [
    { "date": "2026-09-01", "type": "charge", "amountCents": 150000 },
    { "date": "2026-10-01", "type": "charge", "amountCents": 150000 },
    { "date": "2026-10-02", "type": "payment", "amountCents": 50000 }
  ],
  "amountOwedCents": 250000,
  "attestations": {
    "authority": true,
    "notRetaliatory": true,
    "notDiscriminatory": true,
    "servicemember": "no",
    "caresCovered": false
  }
}'

GET /v1/cases

List the cases of the key's organization and mode, optionally only those one person opened (`openedBy`), or those of one landlord (`landlordId`, or `none` for the cases with no landlord)

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
cursorquerystringNoThe nextCursor of the previous page. Omit it for the first page.
limitquerystringNoPage size, 1 to 100. Default 20; a larger value is treated as 100.
openedByquerystringNo—
landlordIdquerystringNo—

Responses

StatusMeaningBody
200A page of cases, newest first.{ items: Case[], nextCursor: string | null }
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/cases
curl "https://api.evictionsapi.com/v1/cases?limit=20" \
  -H "Authorization: Bearer eak_test_..."

GET /v1/cases/gaps

What your draft cases still need before they can be submitted: for each draft with something open (your 25 newest drafts, with `more` true when there are others; or the one case `caseId` names), every failing submission check and every detail still asked for, each as one sentence (`message`) with at most one `action`. `open_field`: enter it (`field` is the case-data path). `upload`: add the document with that `purpose` (`POST /v1/cases/{id}/documents`). `apply`: send `code` and `shownCents` to `POST /v1/cases/{id}/gaps/apply` to set a figure that follows from the case's own ledger (the value is in `label`); it is offered only for the amount owed and the rent owed, and never for a figure of zero. A draft whose checks could not be run is listed with `unavailable: true` and no gaps. `action` is null where nothing you can change closes the gap. A case that is not a draft has none

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
caseIdquerystringNo—

Responses

StatusMeaningBody
200The drafts with gaps, newest first.{ items: CaseGaps[] }
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/cases/gaps
curl https://api.evictionsapi.com/v1/cases/gaps \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/gaps/apply

Set a draft's amount owed (`amount_owed`) or rent owed (`rent_owed`) to the figure its own ledger gives, as `GET /v1/cases/gaps` offered it. The figure is worked out again by the server and stored with the source `ledger_rows`; `shownCents` is only compared with it

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
codestringYesOne of: "amount_owed", "rent_owed".
shownCentsintegerYes0 or more.

Responses

StatusMeaningBody
200The case, with the figure set.Case
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
409`gap_changed`: the ledger changed since the figure was offered, or there is nothing to set (no ledger, a ledger that owes nothing, a figure the case already holds). Nothing was written.Error
422The case did not pass a check.Error

Example

curl example for POST /v1/cases/{id}/gaps/apply
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../gaps/apply \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "code": "amount_owed", "shownCents": 250000 }'

GET /v1/cases/{id}

Get a case

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The case.Case
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/cases/{id}
curl https://api.evictionsapi.com/v1/cases/case_... \
  -H "Authorization: Bearer eak_test_..."

PATCH /v1/cases/{id}

Change the facts of a draft case, or (`paymentMethodId`, in any state) the saved card a full-service case is charged to. 409 `not_agent_filed` for a card on a case that is not full-service; 422 `payment_method_not_found` for a card that is not one of the organization's usable cards in this mode

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
groundstringNoOne of: "nonpayment", "lease_violation", "holdover".
entryPointstringNoOne of: "notice", "filing".
propertyobjectNo—
property.line1stringIf property is sent1 to 200 characters.
property.unitstringNo1 to 50 characters.
property.citystringIf property is sent1 to 100 characters.
property.countystringNoThe county, as the US Census Bureau lists it or by its short name, in any case ("Henry County", "Henry", "henry"). It is stored by its short name ("Henry"); a county the state does not have is refused (400 `invalid_request`). 1 to 100 characters.
property.statestringIf property is sentPattern ^[A-Za-z]{2}$.
property.zipstringIf property is sentPattern ^\d{5}(-\d{4})?$.
property.ownerOfRecordstringIf property is sent1 to 200 characters.
partiesarray of objectNoUp to 20 items.
parties[].rolestringIf parties is sentOne of: "plaintiff", "defendant".
parties[].namestringIf parties is sent1 to 200 characters.
parties[].isEntitybooleanNo—
parties[].phonestringNo1 to 40 characters.
leaseobjectNo—
lease.startDatestringNo—
lease.endDatestringNo—
lease.monthlyRentCentsintegerNo0 or more.
lease.noticePeriodDaysintegerNo1 to 365.
lease.monthToMonthbooleanNo—
lease.terminationNoticeDatestringNo—
lease.noticeMethodsstringNoThe additional ways the rental agreement says a notice must be delivered, exactly as the lease states them, or the word `none`. Asked for where a place's notice states them (Georgia): the notice is posted on the door and says it is also delivered by these methods, or that the rental agreement provides none. 1 to 500 characters.
ledgerarray of objectNoUp to 1000 items.
ledger[].datestringIf ledger is sent—
ledger[].typestringIf ledger is sentOne of: "charge", "payment".
ledger[].amountCentsintegerIf ledger is sent0 or more.
ledger[].memostringNo1 to 500 characters.
ledger[].kindstringNoWhat a charge is for: `rent`, `late_fee`, `utilities`, `other_fee` (any other charge), or a cost of the eviction itself: `eviction_fee`, `attorney_fee` or `court_cost`. A charge only; a payment has none. Where every charge has a kind, a place's documents itemise what is past due by kind (Georgia's notice demands only charges dated on or before its date, and never an `eviction_fee`, `attorney_fee` or `court_cost`, which are not owed before filing); a charge without a kind is accepted, except where the place's documents itemise the ledger by kind (Georgia full-service nonpayment cases today), where every charge must have a kind at submission. One of: "rent", "late_fee", "utilities", "other_fee", "eviction_fee", "attorney_fee", "court_cost".
amountOwedCentsintegerNo0 or more.
ledgerPaymentsAppliedstringNoHow the payments on the ledger are applied to its charges. Absent or `oldest_first`: each payment goes to the oldest unpaid charge, whatever it is for. `rent_first`: every payment goes to rent before any other charge, for a lease that says so. It decides the rent past due and the other amounts a place's documents itemise from the ledger, and the most `rentOwedCents` may be there. One of: "oldest_first", "rent_first".
rentOwedCentsintegerNo0 or more.
violationobjectNo—
violation.descriptionstringIf violation is sent1 to 5000 characters.
violation.datestringIf violation is sent—
attestationsobjectNo—
attestations.authoritybooleanNo—
attestations.notRetaliatorybooleanNo—
attestations.notDiscriminatorybooleanNo—
attestations.servicememberstringNoOne of: "no", "yes", "unknown".
attestations.caresCoveredbooleanNo—
attestations.subsidizedbooleanNo—
attestations.lateBeforeNoticeMonthbooleanNo—
plaintiffContactobjectNo—
plaintiffContact.addressstringIf plaintiffContact is sent1 to 500 characters.
plaintiffContact.phonestringIf plaintiffContact is sent1 to 40 characters.
plaintiffContact.emailstringNoFormat: email. Up to 254 characters. 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,}$.
priorNoticeobjectNo—
priorNotice.servedDatestringIf priorNotice is sent—
priorNotice.methodstringIf priorNotice is sentOne of: "personal", "substitute", "posting", "certified_mail", "first_class_mail", "text_message", "email".
priorNotice.periodDaysintegerIf priorNotice is sent1 to 365.
priorNotice.typestringNoOne of: "notice_to_vacate", "notice_to_pay_rent_or_vacate", "pay_or_quit", "cure_or_quit".
priorNotice.sealedEnvelopebooleanNoWhether the notice already served was posted in a sealed envelope on the door of the premises, as the person states it. Asked for where a place's filing states it (Georgia): the filing says so, and a posted notice answered `false` there does not pass the prior-notice check.
managedContextobjectNo—
managedContext.plaintiffTypestringIf managedContext is sentOne of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other".
managedContext.courtIdstringIf managedContext is sent1 to 200 characters.
managedContext.forumstringIf managedContext is sent1 to 100 characters.
managedContext.residentialbooleanIf managedContext is sent—
managedContext.phasestringIf managedContext is sentOne of: "initial", "contested", "jury", "appeal", "post_judgment".
managedContext.reliefobjectIf managedContext is sent—
managedContext.relief.possessionbooleanIf managedContext is sent—
managedContext.relief.moneyCentsintegerIf managedContext is sent0 or more.
managedContext.relief.itemsobjectNo—
managedContext.relief.items.rentCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.items.lateFeesCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.items.utilitiesCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.items.otherCentsintegerIf managedContext.relief.items is sent0 or more.
managedContext.relief.leaseProvidesChargesbooleanNoAlways true.
managedContext.actorsarray of objectIf managedContext is sentUp to 30 items.
managedContext.actors[].idstringIf managedContext is sent1 to 100 characters.
managedContext.actors[].namestringNo1 to 200 characters.
managedContext.actors[].relationshipstringIf managedContext is sentOne of: "plaintiff_self", "plaintiff_officer", "plaintiff_employee", "property_manager", "platform_employee", "friend_relative", "counsel", "court_officer", "process_server".
managedContext.actors[].actionsarray of stringIf managedContext is sentAt least 1 items.
freeTextstringNoUp to 5000 characters.
sourcesobjectNo—
managedFactsobjectNo—
managedFacts.declarationsarray of objectNo1 to 7 items.
managedFacts.declarations[].contextobjectIf managedFacts.declarations is sent—
managedFacts.declarations[].context.plaintiffTypestringIf managedFacts.declarations is sentOne of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other".
managedFacts.declarations[].context.courtIdstringIf managedFacts.declarations is sent1 to 200 characters.
managedFacts.declarations[].context.forumstringIf managedFacts.declarations is sent1 to 100 characters.
managedFacts.declarations[].context.residentialbooleanIf managedFacts.declarations is sent—
managedFacts.declarations[].context.phasestringIf managedFacts.declarations is sentOne of: "initial", "contested", "jury", "appeal", "post_judgment".
managedFacts.declarations[].context.reliefobjectIf managedFacts.declarations is sent—
managedFacts.declarations[].context.relief.possessionbooleanIf managedFacts.declarations is sent—
managedFacts.declarations[].context.relief.moneyCentsintegerIf managedFacts.declarations is sent0 or more.
managedFacts.declarations[].context.relief.itemsobjectNo—
managedFacts.declarations[].context.relief.items.rentCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.items.lateFeesCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.items.utilitiesCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.items.otherCentsintegerIf managedFacts.declarations[].context.relief.items is sent0 or more.
managedFacts.declarations[].context.relief.leaseProvidesChargesbooleanNoAlways true.
managedFacts.declarations[].context.actorsarray of objectIf managedFacts.declarations is sentUp to 30 items.
managedFacts.declarations[].context.actors[].idstringIf managedFacts.declarations is sent1 to 100 characters.
managedFacts.declarations[].context.actors[].namestringNo1 to 200 characters.
managedFacts.declarations[].context.actors[].relationshipstringIf managedFacts.declarations is sentOne of: "plaintiff_self", "plaintiff_officer", "plaintiff_employee", "property_manager", "platform_employee", "friend_relative", "counsel", "court_officer", "process_server".
managedFacts.declarations[].context.actors[].actionsarray of stringIf managedFacts.declarations is sentAt least 1 items.
managedFacts.declarations[].sourcestringIf managedFacts.declarations is sentOne of: "customer", "suggestion".
managedFacts.declarations[].provenanceobjectNo—
managedFacts.declarations[].provenance.sourcestringIf managedFacts.declarations[].provenance is sentOne of: "lease_file", "buildium", "doorloop", "address", "ledger_file", "messages", "draft_file", "agent".
managedFacts.declarations[].provenance.confidencenumberNo0 to 1.
managedFacts.declarations[].provenance.labelstringIf managedFacts.declarations[].provenance is sent1 to 200 characters.
managedFacts.dismissedarray of stringNo1 to 7 items.
paymentMethodIdanyNoFull-service cases only: the id of the organization's saved card (`GET /v1/payment-methods`) to charge this case's costs to, or null to use the default card. A body with only this field needs the permission to manage payment methods; 422 `payment_method_not_found` when the card is not one of the organization's usable cards in this mode.
landlordIdanyNoThe owner the organization acts for on this case: the id of one of its active landlords (`GET /v1/landlords`). On a draft only. Choosing one adds its current management agreement to the case as an authority document, unless the case already has that file; changing it later adds the new landlord's agreement and removes nothing. Live cases only: landlords are real owners, so a test case never takes one. 422 `landlord_not_found` for a landlord that is not one of the organization's active landlords, and for any landlord on a test case. null: no landlord (the documents stay). 409 `invalid_state` once the case is not a draft.

Responses

StatusMeaningBody
200The updated case.Case
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 PATCH /v1/cases/{id}
curl -X PATCH https://api.evictionsapi.com/v1/cases/case_... \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "amountOwedCents": 250000 }'

GET /v1/cases/{id}/managed-facts

Which facts one proposed act of a managed case is missing. The facts are the customer's declaration, and an empty list is not permission to perform the act

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
actionquerystringYes—

Responses

StatusMeaningBody
200What the act is missing, and whether the facts are the customer's own declaration.ManagedFacts
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/cases/{id}/managed-facts
curl https://api.evictionsapi.com/v1/cases/case_.../managed-facts \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/documents

Upload evidence for a draft case: a PDF, JPEG or PNG, decided by the file's contents (415 `unsupported_media_type` otherwise, for a live case). A `correspondence` document may also be plain UTF-8 text, such as the body of a forwarded email, stored as `text/plain`. For a live case, `purpose: "other"` files can also be added after submission, until the case is finished

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
filenamestringYes1 to 255 characters.
purposestringYesOne of: "authority", "prior_notice", "prior_notice_proof", "other", "lease", "ledger", "correspondence".
contentBase64stringYesAt least 1 characters.

Responses

StatusMeaningBody
201The stored document.Document
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/cases/{id}/documents
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../documents \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "filename": "deed.pdf",
  "purpose": "authority",
  "contentBase64": "ZGVlZA=="
}'

POST /v1/cases/{id}/documents/from-intake

Move a waiting file of the intake inbox onto a live case as a document of `purpose`, as an upload of the same file would be (the same checks apply: 409 `invalid_state` once a case is submitted, except `purpose: "other"`). The text of a forwarded email (`text/plain`) moves only as `correspondence`; any other purpose answers 415 `unsupported_media_type`. The file leaves the inbox. Moving a file already moved onto this case answers 200 with the same document; a test case answers 422 `live_only`

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
intakeFileIdstringYesPattern ^intake_[A-Za-z0-9-]+$.
purposestringYesOne of: "lease", "ledger", "correspondence", "other".

Responses

StatusMeaningBody
201The new document (200: the file was already moved onto this case, and this is its document).Document
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/cases/{id}/documents/from-intake
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../documents/from-intake \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "intakeFileId": "intake_0b7e4c1a-5d2f-4f8e-9a3b-6c1d2e3f4a5b",
  "purpose": "lease"
}'

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

Download a document of the case

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
docIdpathstringYesThe document id.

Responses

StatusMeaningBody
200The document bytes, with the stored `Content-Type`: `application/pdf`, `image/jpeg` or `image/png`, or `text/plain; charset=utf-8` for a plain-text `correspondence` document, as an attachment.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/cases/{id}/documents/{docId}
curl https://api.evictionsapi.com/v1/cases/case_.../documents/doc_... \
  -H "Authorization: Bearer eak_test_..." \
  -o document.pdf

POST /v1/cases/{id}/validate

Run the submission gates on a draft

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The gate results.GateResults
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/cases/{id}/validate
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../validate \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/submit

Submit a draft that passes every gate. A live case is submitted only with its platform fee paid. An attorney-direct case whose fee is not paid stays a draft and answers 402 `payment_required` with the charge to pay (`details.chargeId`, `details.amountCents`, `details.payAt`): open its checkout (`/v1/cases/{id}/charges/{chargeId}/checkout`), and when the payment is recorded the case moves to `submitted` by itself and we engage a licensed attorney in the property's state; nothing is served or filed until that attorney has reviewed it. A full-service case needs its signed authorization and a saved card, and its fee is charged to that card when we begin. Send no `Idempotency-Key` you already used for this case's submission: a stored 402 would be replayed after the payment. A test case enters review by the built-in test reviewer

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The case after submission, and the gate results.{ case: Case, gates: object[] }
400The request is invalid.Error
401The credential is missing or invalid.Error
402`payment_required`: the case passed its checks and stays a draft until its platform fee is paid. `details` names the charge.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/cases/{id}/submit
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../submit \
  -H "Authorization: Bearer eak_test_..."

GET /v1/cases/{id}/authorization

The authorization text of the case, and whether it is signed and still current: for a full-service case, the authorization for us to act as the owner's agent there; for any other live case, the general authorization the owner signs before paying the fee. 409 `not_agent_filed` for a test case that is not a full-service case

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The text to sign, the signature in force and whether it is stale.Authorization
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/cases/{id}/authorization
curl https://api.evictionsapi.com/v1/cases/case_.../authorization \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/authorization

Sign the authorization of the case, for the facts as they are now: a full-service case only while it is a draft, any other live case while it is open (409 `invalid_state` otherwise); 409 `not_agent_filed` for a test case that is not a full-service case. Signing again replaces the earlier signature

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
signerNamestringYes1 to 200 characters.
signerTitlestringNo1 to 200 characters.
acceptbooleanYesAlways true.

Responses

StatusMeaningBody
201The signature.Signature
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/cases/{id}/authorization
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../authorization \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "signerName": "Pat Landlord", "signerTitle": "Owner", "accept": true }'

GET /v1/cases/{id}/signatures/complaint

The complaint documents the owner must sign on an agent-filed case, and whether they are signed. 409 `not_required` when the county has us sign the complaint, or there is none yet; 409 `not_agent_filed` for any other case

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The documents and whether this exact set is signed.ComplaintToSign
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/cases/{id}/signatures/complaint
curl https://api.evictionsapi.com/v1/cases/case_.../signatures/complaint \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/signatures/complaint

Sign the complaint of an agent-filed case, where the county requires the owner to. Only while the case waits for the signature in `filing_approved`; 409 `not_required` otherwise, and 409 `not_agent_filed` for any other case. The filing is queued once. Where the filing is an affidavit sworn by electronic verification (`sworn` on the GET), only the named affiant signs, `accept: true` is the oath, `signerName` must be the affiant's name as printed (case and spacing aside; 422 `affiant_name_mismatch`), and `documentHashes` must be the `sworn.documents` hashes read (409 `documents_changed` when the affidavit changed since, for example on a new day): those documents become the filing

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
signerNamestringYes1 to 200 characters.
acceptbooleanYesAlways true.
documentHashesarray of stringNo1 to 20 items.

Responses

StatusMeaningBody
201The signature.Signature
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/cases/{id}/signatures/complaint
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../signatures/complaint \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "signerName": "Pat Landlord", "accept": true }'

GET /v1/cases/{id}/signatures/complaint/documents/{specId}

Download a sworn affidavit by its spec id. Before the oath (while the case waits for it in `filing_approved`): exactly as it will be filed if your named person swears it now, signed "/s/" with the affiant's name and dated today (the court's day). Once sworn: the affidavit that was sworn, as stored for the filing. 404 for any other document or case; 410 `erased` for an erased case

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
specIdpathstringYes—

Responses

StatusMeaningBody
200The PDF, as an attachment.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
422The case did not pass a check.Error

Example

curl example for GET /v1/cases/{id}/signatures/complaint/documents/{specId}
curl https://api.evictionsapi.com/v1/cases/case_.../signatures/complaint/documents/specId_... \
  -H "Authorization: Bearer eak_test_..." \
  -o document.pdf

GET /v1/cases/{id}/tasks

The outward steps of a full-service case, oldest first, each with its status and dates. 409 `not_agent_filed` for any other case

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The steps.{ items: Task[] }
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/cases/{id}/tasks
curl https://api.evictionsapi.com/v1/cases/case_.../tasks \
  -H "Authorization: Bearer eak_test_..."

GET /v1/cases/{id}/events

Customer-visible events of the case, oldest first

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The events.{ items: Event[] }
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/cases/{id}/events
curl https://api.evictionsapi.com/v1/cases/case_.../events \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/report-cure

Report that the tenant has paid or cured. For a live case the report is recorded and passed on to the attorney; the case is not closed automatically

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The case.Case
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/cases/{id}/report-cure
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../report-cure \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/withdraw

Withdraw the case. A live case with an attorney already engaged goes `on_hold` with a `withdrawal_requested` event instead, and is withdrawn once the attorney has confirmed that all work has stopped

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The case: withdrawn, or on hold while the withdrawal is confirmed.Case
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/cases/{id}/withdraw
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../withdraw \
  -H "Authorization: Bearer eak_test_..."

GET /v1/cases/{id}/charges

The charges on the case, oldest first, and whether online payment is available

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The charges. `paymentsEnabled` false: charges show as due and `checkout` answers 409 `payments_unavailable`.{ items: Charge[], paymentsEnabled: boolean }
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/cases/{id}/charges
curl https://api.evictionsapi.com/v1/cases/case_.../charges \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/charges/{chargeId}/checkout

Open a hosted checkout for one due charge. 409 `authorization_required` until the owner has signed the case's authorization (`/v1/cases/{id}/authorization`); 409 `payments_unavailable` when online payment is off; 409 `charge_not_due` when the charge is paid, void or refunded; 409 `automatic_charge` for a charge taken from the saved card

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
chargeIdpathstringYes—

Responses

StatusMeaningBody
200The checkout URL to send the customer to. They return to the case page on the website.{ url: string }
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/cases/{id}/charges/{chargeId}/checkout
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../charges/chargeId_.../checkout \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/charges/{chargeId}/confirm

Check with the payment provider whether the charge's checkout was paid, and record it if so. Safe to repeat. 409 `payments_unavailable` when online payment is off; 409 `automatic_charge` for a charge taken from the saved card

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.
chargeIdpathstringYes—

Responses

StatusMeaningBody
200The charge as it now is.Charge
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/cases/{id}/charges/{chargeId}/confirm
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../charges/chargeId_.../confirm \
  -H "Authorization: Bearer eak_test_..."

GET /v1/payment-methods

The organization's saved cards for the automatic charges of full-service cases, in the key's mode: the default first, then newest first. Anyone in the organization can read them

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The cards.{ items: Card[] }
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/payment-methods
curl https://api.evictionsapi.com/v1/payment-methods \
  -H "Authorization: Bearer eak_test_..."

POST /v1/payment-methods/setup

Open the payment provider's page for adding a card. The card number is typed there and never reaches the API. The customer comes back to `returnPath` on the website with `setup_session` in the query (and `default=true` when `default` was asked for); send those to `confirm`. With a test key there is no card page and no real card: the returned URL only carries the setup's id in its `session` parameter; finish the setup with `POST /v1/payment-method/test-setup`, then `confirm` it. Needs the permission to manage payment methods. In live mode, 409 `live_unavailable` until live full-service cases are switched on; 503 `payments_unavailable` when online payment is off

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
returnPathstringYesUp to 200 characters. Pattern ^\/app(\/[A-Za-z0-9_-]+)*$.
defaultbooleanNo—

Responses

StatusMeaningBody
200The URL to send the customer to.{ url: string }
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/payment-methods/setup
curl -X POST https://api.evictionsapi.com/v1/payment-methods/setup \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "returnPath": "/app/billing", "default": true }'

POST /v1/payment-methods/confirm

Add the card of a finished setup to the organization's cards in this mode. It becomes the default with `default: true`, or when the organization has no usable default. Every automatic charge still due is then retried shortly after, in the background. Safe to repeat: a card already added is answered as it is. 409 `setup_incomplete` while the card is not saved yet; 404 for a setup that is unknown, another organization's, or of a card removed since

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
sessionIdstringYes1 to 255 characters.
defaultbooleanNo—

Responses

StatusMeaningBody
200The card.Card
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/payment-methods/confirm
curl -X POST https://api.evictionsapi.com/v1/payment-methods/confirm \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "sessionId": "cs_test_a1B2c3", "default": true }'

PATCH /v1/payment-methods/{id}

Name a card (`label`, null to clear it), make it the default (`default: true`), or say which saved landlord it is for (`landlordId`, null for none; 404 `landlord_not_found` when it is not one of the organization's landlords). 422 `payment_method_unusable` for a declined card made the default, and then nothing is changed. 404 for a card that is not one of the organization's in this mode. Each change is in the organization's activity log

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
labelanyNo—
defaultbooleanNoAlways true.
landlordIdanyNoThe saved landlord (`GET /v1/landlords`) whose card this is, or null for none. 404 `landlord_not_found` when it is not one of the organization's landlords.

Responses

StatusMeaningBody
200The card as it now is.Card
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 PATCH /v1/payment-methods/{id}
curl -X PATCH https://api.evictionsapi.com/v1/payment-methods/case_... \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "label": "Operating account card", "default": true }'

DELETE /v1/payment-methods/{id}

Remove a card: it is detached at the payment provider and never charged again. When it was the default, the newest card left that works becomes the default; with none left, a full-service case with a cost due waits until a card is added. 404 for a card that is not one of the organization's in this mode

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
204The card is removed.—
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 DELETE /v1/payment-methods/{id}
curl -X DELETE https://api.evictionsapi.com/v1/payment-methods/case_... \
  -H "Authorization: Bearer eak_test_..."

GET /v1/charges

Every charge of the organization's cases in this mode, newest first, optionally only one status, the charges created between two days (UTC), or the charges of one landlord's cases (`landlordId`, or `none` for the cases with no landlord), with the billing page's totals. Anyone in the organization can read them

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
cursorquerystringNoThe nextCursor of the previous page. Omit it for the first page.
limitquerystringNoPage size, 1 to 100. Default 20; a larger value is treated as 100.
statusquerystringNo—
fromquerystringNo—
toquerystringNo—
landlordIdquerystringNo—

Responses

StatusMeaningBody
200A page of charges, and the totals over all of them. `paymentsEnabled` false: online payment is off, and `checkout` answers 409 `payments_unavailable`.{ items: CustomerCharge[], nextCursor: string | null, paymentsEnabled: boolean, totals: ChargeTotals }
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/charges
curl "https://api.evictionsapi.com/v1/charges?status=due&limit=20" \
  -H "Authorization: Bearer eak_test_..."

GET /v1/charges.csv

The same charges as a CSV file (at most 10,000 rows, newest first), named `charges-YYYY-MM-DD.csv` after the day of the request. Columns: created_at, charge_id, case_id, state, landlord, kind, description, amount_usd, status, paid_at, receipt_url. `landlord` is the display name of the case's landlord, empty when it has none. No tenant names, addresses or payment-provider ids

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
statusquerystringNo—
fromquerystringNo—
toquerystringNo—
landlordIdquerystringNo—

Responses

StatusMeaningBody
200The CSV file, as an attachment.stringtext/csv
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/charges.csv
curl https://api.evictionsapi.com/v1/charges.csv \
  -H "Authorization: Bearer eak_test_..."

GET /v1/charges/by-landlord

The organization's charges in this mode totalled per landlord of their cases (what a manager bills back to each owner): due, paid this calendar year (UTC), and how many charges. Only landlords with charges, archived ones included, by name; the cases with no landlord last, as "No landlord". The lines add up to the totals of `GET /v1/charges`. Anyone in the organization can read them

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200One line per landlord.{ 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/charges/by-landlord
curl https://api.evictionsapi.com/v1/charges/by-landlord \
  -H "Authorization: Bearer eak_test_..."

GET /v1/landlords

The owners the organization acts for, by name, each with how many of its cases in this mode name them. Archived ones only with `includeArchived=true`. Anyone in the organization can read them with a live key or a signed-in session; a test key always gets an empty list, since landlords are real owners shared with the organization's live cases

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
includeArchivedquerystringNo—

Responses

StatusMeaningBody
200The landlords.{ items: Landlord[] }
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/landlords
curl "https://api.evictionsapi.com/v1/landlords?includeArchived=true" \
  -H "Authorization: Bearer eak_test_..."

POST /v1/landlords

Save an owner the organization acts for. `ownerOfRecord` defaults to the name. Needs the permission to manage landlords. In the organization's activity log by its id only. 409 `landlord_limit` once the organization keeps 1,000 saved landlords, archived ones included. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringYes1 to 200 characters.
isEntitybooleanYes—
plaintiffTypeanyNo—
ownerOfRecordstringNo1 to 200 characters.
contactobjectYes—
contact.addressstringYes1 to 500 characters.
contact.phonestringYes1 to 40 characters.
contact.emailstringNoFormat: email. Up to 254 characters. 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,}$.
notesstringNoUp to 1000 characters.

Responses

StatusMeaningBody
201The landlord.Landlord
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/landlords
curl -X POST https://api.evictionsapi.com/v1/landlords \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pat Landlord LLC",
  "isEntity": true,
  "plaintiffType": "llc",
  "contact": {
    "address": "100 Owner Ave, Testville, ZZ 00000",
    "phone": "555-0100",
    "email": "pat@example.com"
  }
}'

GET /v1/landlords/{id}

One landlord, archived or not, with its current management agreement. 404 `landlord_not_found` for one that is not the organization's, and for any landlord asked for with a test key

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe landlord id.

Responses

StatusMeaningBody
200The landlord, and its management agreement or null.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/landlords/{id}
curl https://api.evictionsapi.com/v1/landlords/lnd_... \
  -H "Authorization: Bearer eak_test_..."

PATCH /v1/landlords/{id}

Change a landlord, archived or not: only the fields given change; `contact` is replaced whole; null clears `plaintiffType` and `notes`. Cases already opened keep what they were given; a change that leaves it as it was is not logged. 404 `landlord_not_found` for one that is not the organization's. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe landlord id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringNo1 to 200 characters.
isEntitybooleanNo—
plaintiffTypeanyNo—
ownerOfRecordstringNo1 to 200 characters.
contactobjectNo—
contact.addressstringIf contact is sent1 to 500 characters.
contact.phonestringIf contact is sent1 to 40 characters.
contact.emailstringNoFormat: email. Up to 254 characters. 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,}$.
notesanyNo—

Responses

StatusMeaningBody
200The landlord as it now is.Landlord
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 PATCH /v1/landlords/{id}
curl -X PATCH https://api.evictionsapi.com/v1/landlords/lnd_... \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "contact": {
    "address": "200 Owner Ave, Testville, ZZ 00000",
    "phone": "555-0101"
  }
}'

POST /v1/landlords/{id}/archive

Archive a landlord: its cases and charges stay, and it can no longer be chosen for a new case until it is unarchived. Never deleted. Archiving again changes nothing. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe landlord id.

Responses

StatusMeaningBody
200The landlord.Landlord
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/landlords/{id}/archive
curl -X POST https://api.evictionsapi.com/v1/landlords/lnd_.../archive \
  -H "Authorization: Bearer eak_test_..."

POST /v1/landlords/{id}/unarchive

Unarchive a landlord, so it can be chosen for a new case again. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe landlord id.

Responses

StatusMeaningBody
200The landlord.Landlord
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/landlords/{id}/unarchive
curl -X POST https://api.evictionsapi.com/v1/landlords/lnd_.../unarchive \
  -H "Authorization: Bearer eak_test_..."

POST /v1/landlords/{id}/documents

Upload the landlord's management agreement: a PDF, JPEG or PNG of at most 10 MB, decided by the file's contents (415 `unsupported_media_type` otherwise; 413 when larger). It replaces the current agreement; the earlier one is kept but no longer listed. 409 `landlord_file_limit` once the landlord has 20 files, replaced ones included. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe landlord id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
filenamestringYes1 to 255 characters.
contentBase64stringYesAt least 1 characters.
purposestringNoAlways "management_agreement".

Responses

StatusMeaningBody
201The stored agreement.LandlordDocument
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/landlords/{id}/documents
curl -X POST https://api.evictionsapi.com/v1/landlords/lnd_.../documents \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "filename": "management-agreement.pdf",
  "purpose": "management_agreement",
  "contentBase64": "JVBERi0xLjcK"
}'

GET /v1/landlords/{id}/documents/{docId}

Download one of the landlord's files. 404 `landlord_not_found` for a landlord that is not the organization's, and for any landlord with a test key; 404 `not_found` for a file that is not the landlord's

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe landlord id.
docIdpathstringYesThe document id.

Responses

StatusMeaningBody
200The file's bytes, with the stored `Content-Type` (`application/pdf`, `image/jpeg` or `image/png`), as an attachment.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
422The case did not pass a check.Error

Example

curl example for GET /v1/landlords/{id}/documents/{docId}
curl https://api.evictionsapi.com/v1/landlords/lnd_.../documents/doc_... \
  -H "Authorization: Bearer eak_test_..." \
  -o document.pdf

GET /v1/payment-method

The default card for the automatic charges of full-service cases, in the key's mode, or null when there is none. Kept for older clients: `GET /v1/payment-methods` lists every card

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The card's brand, last four and status, or null.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/payment-method
curl https://api.evictionsapi.com/v1/payment-method \
  -H "Authorization: Bearer eak_test_..."

POST /v1/payment-method/setup

Open the payment provider's page for saving a card. The card number is typed there and never reaches the API. The customer comes back to `returnPath` on the website with `setup_session` in the query; send that to `confirm`. With a test key there is no card page and no real card: the returned URL only carries the setup's id in its `session` parameter; finish the setup with `POST /v1/payment-method/test-setup`, then `confirm` it. In live mode, 409 `live_unavailable` until live full-service cases are switched on (the full service is offered only in test mode for now). 503 `payments_unavailable` when online payment is off

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
returnPathstringYesUp to 200 characters. Pattern ^\/app(\/[A-Za-z0-9_-]+)*$.

Responses

StatusMeaningBody
200The URL to send the customer to.{ url: string }
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/payment-method/setup
curl -X POST https://api.evictionsapi.com/v1/payment-method/setup \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "returnPath": "/app/cases/new" }'

POST /v1/payment-method/confirm

Add the card of a finished setup to the organization's cards in this mode, as the default card (kept for older clients: `POST /v1/payment-methods/confirm` chooses). Every automatic charge still due is then retried on it shortly after, in the background; a case on hold for a declined card continues once its costs are paid. Safe to repeat. 409 `setup_incomplete` while the card is not saved yet; in live mode, 409 `live_unavailable` until live full-service cases are switched on

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
sessionIdstringYes1 to 255 characters.

Responses

StatusMeaningBody
200The saved card.PaymentMethod
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/payment-method/confirm
curl -X POST https://api.evictionsapi.com/v1/payment-method/confirm \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "sessionId": "cs_test_a1B2c3" }'

POST /v1/payment-method/test-setup

Test mode only (409 `sandbox_only` otherwise): finish a test setup with one of the two test cards, `success` (Visa ending 4242) or `decline` (ending 0002, which declines every charge). `sessionId` is the `session` parameter of the URL that `POST /v1/payment-method/setup` returned for the test key

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
sessionIdstringYes1 to 255 characters.
cardstringYesOne of: "success", "decline".

Responses

StatusMeaningBody
200Where to send the customer next: the setup's return URL.{ returnUrl: string }
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/payment-method/test-setup
curl -X POST https://api.evictionsapi.com/v1/payment-method/test-setup \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "sessionId": "setup_test_a1B2c3", "card": "success" }'

GET /v1/cases/{id}/notes

The messages on the case: the customer's own and ours, oldest first

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The messages.{ items: Note[] }
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/cases/{id}/notes
curl https://api.evictionsapi.com/v1/cases/case_.../notes \
  -H "Authorization: Bearer eak_test_..."

POST /v1/cases/{id}/notes

Send us a message about a live case. 409 `attorney_direct_only` for a test case. At most 20 every 10 minutes per organization (429 `rate_limited`)

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
bodystringYes1 to 5000 characters.

Responses

StatusMeaningBody
201The stored message.Note
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/cases/{id}/notes
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../notes \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "body": "The tenant paid half of the balance yesterday. Does that change the next step?"
}'

POST /v1/cases/{id}/advance

Test keys only: move a test case on by one step. Runs the step the case is waiting for now (the test reviewer's review, a service or filing update, or the end of the notice period on the case's own test clock), or records the next court outcome as the test reviewer. A live case (nothing about a real case is ever advanced automatically), or a case outside the fictional test state, gets 409 `sandbox_only`; a draft, a case on hold or a finished case gets 409 `nothing_to_advance`, as does a step whose last try failed, until its automatic retry (`error.details.retryAt`). While the step is already being taken, the case is returned as it is. At most 60 a minute per organization (429 `rate_limited`)

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The case after the step.Case
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/cases/{id}/advance
curl -X POST https://api.evictionsapi.com/v1/cases/case_.../advance \
  -H "Authorization: Bearer eak_test_..."

POST /v1/webhook-endpoints

Register a webhook endpoint

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
urlstringYes1 to 2048 characters.

Responses

StatusMeaningBody
201The endpoint. The signing secret appears in this response only. An `Idempotency-Key` header is ignored: every request creates an endpoint, and no response is stored or replayed.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 POST /v1/webhook-endpoints
curl -X POST https://api.evictionsapi.com/v1/webhook-endpoints \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/webhooks/evictions" }'

GET /v1/webhook-endpoints

List the organization's webhook endpoints in the credential's mode. The signing secret is never shown again

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The endpoints, oldest 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/webhook-endpoints
curl https://api.evictionsapi.com/v1/webhook-endpoints \
  -H "Authorization: Bearer eak_test_..."

GET /v1/api-keys

List the organization's API keys in the credential's mode, newest first, revoked ones included. The secret is never shown again

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The keys, each with the last four characters of its secret (null for a key created before they were recorded) and when it was revoked, if it was.{ 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/api-keys
curl https://api.evictionsapi.com/v1/api-keys \
  -H "Authorization: Bearer eak_test_..."

POST /v1/api-keys

Create an API key in the credential's mode, optionally with a name. With `replaceSameName`, the active keys of the mode with that exact name are revoked first, so an app that connects again keeps one key. A live key can be created only by an owner of the organization, signed in with a session and `X-Evictions-Mode: live` (403 `forbidden` otherwise, also for a live API key); at most 10 active keys per mode, counted after any replaced keys (409 `key_limit`, and then nothing is revoked)

Authentication: API key, as Authorization: Bearer eak_test_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringNo1 to 300 characters.
replaceSameNamebooleanNo—

Responses

StatusMeaningBody
201The new key. The secret appears in this response only. An `Idempotency-Key` header is ignored: every request creates a key, and no response is stored or replayed.{ id: string, mode: string, name: string | null, secret: string, replaced: string[] }
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/api-keys
curl -X POST https://api.evictionsapi.com/v1/api-keys \
  -H "Authorization: Bearer eak_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Claude via claude.ai", "replaceSameName": true }'

DELETE /v1/api-keys/{id}

Revoke an API key of the organization and the credential's mode. A key cannot revoke itself (409 `cannot_revoke_current_key`)

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe API key id.

Responses

StatusMeaningBody
204The key is revoked and no longer authenticates. Revoking a revoked key is also 204.—
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 DELETE /v1/api-keys/{id}
curl -X DELETE https://api.evictionsapi.com/v1/api-keys/key_... \
  -H "Authorization: Bearer eak_test_..."

DELETE /v1/webhook-endpoints/{id}

Delete a webhook endpoint. Deliveries still waiting to be retried for it are dropped

Authentication: API key, as Authorization: Bearer eak_test_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe webhook endpoint id.

Responses

StatusMeaningBody
204The endpoint and its delivery log are deleted.—
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 DELETE /v1/webhook-endpoints/{id}
curl -X DELETE https://api.evictionsapi.com/v1/webhook-endpoints/whe_... \
  -H "Authorization: Bearer eak_test_..."

GET /v1/organization

The caller's organization and its members

Authentication: API key, as Authorization: Bearer eak_test_...

Responses

StatusMeaningBody
200The organization and its members.{ id: string, name: string, verified: boolean, kind: string, contactEmail: string | null, contactPhone: string | null, contactAddress: string | null, billingEmail: string | null, members: 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/organization
curl https://api.evictionsapi.com/v1/organization \
  -H "Authorization: Bearer eak_test_..."

PATCH /v1/organization

Change the organization's profile: its name, kind and contact details (`organization.manage`, an owner by default) and the billing contact (`billing.manage`); a request with both needs both. Only the fields given change; null clears one. An API key gets 403

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringNo1 to 120 characters.
kindanyNo—
contactEmailanyNo—
contactPhoneanyNo—
contactAddressanyNo—
billingEmailanyNo—

Responses

StatusMeaningBody
200The organization after the change.{ id: string, name: string, verified: boolean, kind: string, contactEmail: string | null, contactPhone: string | null, contactAddress: string | null, billingEmail: string | null, members: object[] }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`permission_denied`: an API key, or the person lacks `organization.manage` (name, kind, contact details) or `billing.manage` (the billing contact).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 PATCH /v1/organization
curl -X PATCH https://api.evictionsapi.com/v1/organization \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme Property Management" }'

PATCH /v1/organization/members/{userId}

Change a member's role (`owner`, `member`, `viewer`), or give them a `custom` list of permissions. Needs `people.manage`; only an owner makes, changes or removes an owner, and nobody gives a permission they do not hold. The last owner cannot be demoted. The person is emailed unless they changed their own role

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
userIdpathstringYesThe person's user id: a member's id in GET /v1/organization.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription

Responses

StatusMeaningBody
200The member after the change. Asking for the role they already have changes nothing.{ id: string, membershipId: string, name: string | null, email: string, role: string, permissions: string[], caseEmails: string, joinedAt: string, lastLoginAt: string | null, you: boolean, disabled: boolean }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and the change concerns an owner (making one, changing one, removing one); or is not an owner and gives a permission they do not hold themselves (nobody grants what they do not hold).Error
404`not_found`: the person is not an active member of the organization (the same answer whether or not they exist).Error
409`last_owner`: the person is the organization's last owner. Make someone else an owner first.Error
422The case did not pass a check.Error

Example

curl example for PATCH /v1/organization/members/{userId}
curl -X PATCH https://api.evictionsapi.com/v1/organization/members/usr_... \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "role": "viewer" }'

DELETE /v1/organization/members/{userId}

Remove a person from the organization. Needs `people.manage`; an owner is removed by an owner only, and never the last one. Their sessions acting for the organization are signed out, their other organizations stay, and they are emailed. Their cases, messages and signatures stay with the organization

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
userIdpathstringYesThe person's user id: a member's id in GET /v1/organization.

Responses

StatusMeaningBody
204The person was removed.—
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and the change concerns an owner (making one, changing one, removing one); or is not an owner and gives a permission they do not hold themselves (nobody grants what they do not hold).Error
404`not_found`: the person is not an active member of the organization (the same answer whether or not they exist).Error
409`last_owner`: the person is the organization's last owner. Make someone else an owner first.Error
422The case did not pass a check.Error

Example

curl example for DELETE /v1/organization/members/{userId}
curl -X DELETE https://api.evictionsapi.com/v1/organization/members/usr_... \
  -H "Authorization: Bearer ess_..."

GET /v1/organization/activity

The organization's activity log: invitations, role changes, removals and profile changes, newest first. A signed-in person who manages people; an API key or anyone else gets 403

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
beforequerystringNoThe nextBefore of the previous page. Omit it for the newest rows.

Responses

StatusMeaningBody
200A page of the log.{ items: object[], nextBefore: string }
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/organization/activity
curl https://api.evictionsapi.com/v1/organization/activity \
  -H "Authorization: Bearer ess_..."

GET /v1/organization/invitations

The organization's invitations. A signed-in person who manages people; an API key or anyone else gets 403

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
200The invitations.{ items: object[], link: string }
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/organization/invitations
curl https://api.evictionsapi.com/v1/organization/invitations \
  -H "Authorization: Bearer ess_..."

POST /v1/organization/invitations

Invite a person by email, as an owner (owners only), member or viewer. A pending invitation to the same address is replaced. The link lasts seven days

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
emailstringYesFormat: email. Up to 254 characters. 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,}$.
rolestringYesOne of: "owner", "member", "viewer".

Responses

StatusMeaningBody
201The invitation was emailed; the answer is the list. An `Idempotency-Key` header is ignored.{ items: object[], link: string }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and invites an owner (only an owner does); or is not an owner and does not hold every permission of the role (nobody grants what they do not hold: a person with only `people.manage` invites viewers).Error
404Not found.Error
409`already_member`: the address belongs to a member of the organization. `member_limit`: the organization already has 50 people.Error
422The case did not pass a check.Error
429`invitation_rate_limited`: the organization sent 20 invitations in the last 24 hours, or the person sent 20 across all their organizations, resent and replaced ones included. Nothing was sent. Please try again later.Error

Example

curl example for POST /v1/organization/invitations
curl -X POST https://api.evictionsapi.com/v1/organization/invitations \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "email": "sam@example.com", "role": "member" }'

POST /v1/organization/invitations/{id}/resend

Email a pending invitation again with a new link. The old link stops working

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
200The invitation was emailed again; the answer is the list. An `Idempotency-Key` header is ignored.{ items: object[], link: string }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and invites an owner (only an owner does); or is not an owner and does not hold every permission of the role (nobody grants what they do not hold: a person with only `people.manage` invites viewers).Error
404`not_found`: no pending invitation of the organization has this id.Error
409`already_member`: the address belongs to a member of the organization. `member_limit`: the organization already has 50 people.Error
422The case did not pass a check.Error
429`invitation_rate_limited`: the organization sent 20 invitations in the last 24 hours, or the person sent 20 across all their organizations, resent and replaced ones included. Nothing was sent. Please try again later.Error

Example

curl example for POST /v1/organization/invitations/{id}/resend
curl -X POST https://api.evictionsapi.com/v1/organization/invitations/case_.../resend \
  -H "Authorization: Bearer ess_..."

DELETE /v1/organization/invitations/{id}

Revoke a pending invitation. Its link stops working

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
204The invitation is revoked.—
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
404`not_found`: no pending invitation of the organization has this id.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 DELETE /v1/organization/invitations/{id}
curl -X DELETE https://api.evictionsapi.com/v1/organization/invitations/case_... \
  -H "Authorization: Bearer ess_..."

POST /v1/auth/google

Sign in with Google: the website trades the code Google gave it. Signs in to the account linked to that Google account, else links the account with the same email (with or without a password), else creates one (201) with no password. With `invitationToken` it also accepts that invitation: the Google account's email must be the invited address, a new account gets no organization of its own, and the session acts for the inviting organization. No credential; the website calls this from its servers

Authentication: none

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
codestringYes1 to 2048 characters.
codeVerifierstringYesPattern ^[A-Za-z0-9._~-]{43,128}$.
redirectUristringYes1 to 2048 characters.
invitationTokenstringNo1 to 200 characters.

Responses

StatusMeaningBody
200A new session, with the user and organization (201 when the account was just created). An `Idempotency-Key` header is ignored.{ token: string, user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: object }
400The request is invalid, `redirectUri` is not the website's Google callback, or Google did not accept the code (`invalid_google_code`).Error
403`google_account_not_allowed`: the account may not sign in with Google (a law-firm user, a platform address, or a user already linked to another Google account), or `account_disabled`: the account has been disabled. With `invitationToken`: `account_kind`, an attorney's or the operator's account cannot join an organization.Error
404`invitation_invalid`: `invitationToken` is unknown, already used, revoked or expired. Google was not asked.Error
409With `invitationToken`: `invitation_email_mismatch`, the Google account's email is not the invited address; `already_member`; `member_limit`, the organization already has 50 people. Nothing was created or linked.Error
413The request body is too large.Error
429Too many sign-up and sign-in attempts from this address: at most 10 every 10 minutes, shared with sign-up and sign-in. `Retry-After` gives the seconds to wait.Error
503`google_unavailable`: sign-in with Google is not configured on this server, or Google could not be reached.Error

Example

curl example for POST /v1/auth/google
curl -X POST https://api.evictionsapi.com/v1/auth/google \
  -H "Content-Type: application/json" \
  -d '{
  "code": "4/0AVG7fiQ...",
  "codeVerifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
  "redirectUri": "https://evictionsapi.com/api/session/google/callback"
}'

GET /v1/invitations/{token}

An invitation, from the link in its email: the organization, the role and the invited address, masked. No credential; the token is the credential

Authentication: none

Parameters

NameInTypeRequiredDescription
tokenpathstringYes—

Responses

StatusMeaningBody
200The invitation. `accountExists` says whether the invited address already has an account (then the person signs in to accept).{ organizationName: string, role: string, emailMasked: string, accountExists: boolean }
404`invitation_invalid`: the token is unknown, already used, revoked or expired.Error
429Too many requests from this address: at most 30 every 10 minutes, counting both invitation endpoints. `Retry-After` gives the seconds to wait.Error

Example

curl example for GET /v1/invitations/{token}
curl https://api.evictionsapi.com/v1/invitations/token_...

POST /v1/invitations/{token}/accept

Accept an invitation. Signed out, with a name and a password: makes the account for the invited address, confirmed, and answers 201 with a session for the organization. Signed in as the invited address, with no body: joins the organization and moves the session there (200). An address that already has an account must sign in to accept; its password is never set here

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
tokenpathstringYes—

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringYes1 to 120 characters.
passwordstringYes10 to 200 characters.

Responses

StatusMeaningBody
201A new session for a new account (`token`, shown here only), with the account view; 200 with the account view alone for a signed-in person. An `Idempotency-Key` header is ignored.{ token: string, user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: object }
400`invalid_request`: signed out, the body needs `name` and a `password` of 10 to 200 characters (`details.issues` names them).Error
401`unauthenticated`: an `Authorization` header was sent and is not a valid session.Error
403`account_kind`: an attorney's or the operator's account cannot join an organization. `forbidden`: an API key, or a disabled account.Error
404`invitation_invalid`: the token is unknown, already used, revoked or expired.Error
409`invitation_email_mismatch`: the session is for another address. `email_taken`: signed out, and the invited address already has an account; sign in to accept. `already_member`: the person is a member already. `member_limit`: the organization already has 50 people. Nothing was created and the invitation is still pending.Error
413The request body is too large.Error
429Too many requests from this address: at most 30 every 10 minutes, counting both invitation endpoints. `Retry-After` gives the seconds to wait.Error
503`busy`: too many password checks are waiting. Nothing was created. `Retry-After: 5` gives the seconds to wait.Error

Example

curl example for POST /v1/invitations/{token}/accept
curl -X POST https://api.evictionsapi.com/v1/invitations/token_.../accept \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Sam Rivera", "password": "a long passphrase, not this one" }'

POST /v1/auth/logout

Revoke the session in use

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
204The session is revoked.—
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/auth/logout
curl -X POST https://api.evictionsapi.com/v1/auth/logout \
  -H "Authorization: Bearer ess_..."

POST /v1/auth/password-reset/request

Ask for a password reset link by email. No credential. The answer is the same whether or not the address has an account

Authentication: none

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
emailstringYes1 to 254 characters.

Responses

StatusMeaningBody
202The request was accepted. If the address belongs to an account that signs in to the site, a single-use link valid for one hour was emailed to it. One account is sent at most 3 such emails an hour: a request beyond that gets this same answer and sends nothing. An `Idempotency-Key` header is ignored.{ ok: boolean }
400The request is invalid.Error
413The request body is too large.Error
429Too many password reset requests from this address: at most 10 every 10 minutes, counting both reset endpoints. `Retry-After` gives the seconds to wait.Error

Example

curl example for POST /v1/auth/password-reset/request
curl -X POST https://api.evictionsapi.com/v1/auth/password-reset/request \
  -H "Content-Type: application/json" \
  -d '{ "email": "pat@example.com" }'

POST /v1/auth/password-reset/confirm

Set a new password with the token from a reset link. No credential. The token works once; every session of the user is revoked

Authentication: none

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
tokenstringYes1 to 200 characters.
passwordstringYes10 to 200 characters.

Responses

StatusMeaningBody
200The password was changed and every session of the user was revoked. Sign in again with the new password. An `Idempotency-Key` header is ignored.{ ok: boolean }
400`invalid_reset_token`: the token is unknown, already used or expired. `invalid_request`: the password is not 10 to 200 characters (`details.issues` names `password`).Error
413The request body is too large.Error
429Too many password reset requests from this address: at most 10 every 10 minutes, counting both reset endpoints. `Retry-After` gives the seconds to wait.Error
503`busy`: too many password checks are waiting. Nothing was changed and the token is still unused. `Retry-After: 5` gives the seconds to wait; try again.Error

Example

curl example for POST /v1/auth/password-reset/confirm
curl -X POST https://api.evictionsapi.com/v1/auth/password-reset/confirm \
  -H "Content-Type: application/json" \
  -d '{
  "token": "epr_...",
  "password": "a new long passphrase, not this one"
}'

POST /v1/auth/email-confirm/request

Send a new "Confirm your email" link to the signed-in user's own address. The answer is always 202

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
202The request was accepted. If the address is not confirmed yet, a single-use link valid for three days was emailed to it. One account is sent at most 3 such emails an hour, the one at sign-up included: a request beyond that gets this same answer and sends nothing. An `Idempotency-Key` header is ignored.{ ok: boolean }
400The request is invalid.Error
401No valid session.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
413The request body is too large.Error
422The case did not pass a check.Error
429Too many email confirmation requests from this address: at most 10 every 10 minutes, counting both confirmation endpoints. `Retry-After` gives the seconds to wait.Error

Example

curl example for POST /v1/auth/email-confirm/request
curl -X POST https://api.evictionsapi.com/v1/auth/email-confirm/request \
  -H "Authorization: Bearer ess_..."

POST /v1/auth/email-confirm/confirm

Confirm the address with the token from the emailed link. No credential. The token works once. Confirming is never required for anything

Authentication: none

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
tokenstringYes1 to 200 characters.

Responses

StatusMeaningBody
200The address is confirmed. No session is started or ended. An `Idempotency-Key` header is ignored.{ ok: boolean }
400`invalid_confirmation_token`: the token is unknown, already used or expired.Error
413The request body is too large.Error
429Too many email confirmation requests from this address: at most 10 every 10 minutes, counting both confirmation endpoints. `Retry-After` gives the seconds to wait.Error

Example

curl example for POST /v1/auth/email-confirm/confirm
curl -X POST https://api.evictionsapi.com/v1/auth/email-confirm/confirm \
  -H "Content-Type: application/json" \
  -d '{ "token": "eec_..." }'

GET /v1/me

The signed-in person, the organization this session acts for, their role and permissions in it, and every organization they belong to

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
200The account view. `organization` is null when the person belongs to no organization: only the `/v1/me` routes then work.{ user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: object, extractAvailable: boolean }
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/me
curl https://api.evictionsapi.com/v1/me \
  -H "Authorization: Bearer ess_..."

PATCH /v1/me

Change the signed-in person's name

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringYes1 to 120 characters.

Responses

StatusMeaningBody
200The account view.{ user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: 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 PATCH /v1/me
curl -X PATCH https://api.evictionsapi.com/v1/me \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Pat Landlord" }'

POST /v1/me/organization

Act for another of the person's organizations. The session moves there, and the next sign-in starts there

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
organizationIdstringYes1 to 64 characters.

Responses

StatusMeaningBody
200The account view, acting for that organization.{ user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: 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
404`not_found`: the person is not an active member of that organization (the same answer whether or not it exists).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/me/organization
curl -X POST https://api.evictionsapi.com/v1/me/organization \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "organizationId": "org_..." }'

POST /v1/me/organizations

Start another organization, unverified, with the person as its owner; the session moves to it. Customer accounts only

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
namestringNo1 to 120 characters.
kindstringNoOne of: "owner", "property_manager", "both".

Responses

StatusMeaningBody
201The account view, acting for the new organization. Without `name` it is named after the person.{ user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: object }
400The request is invalid.Error
401The credential is missing or invalid.Error
403`account_kind`: an attorney's or the operator's account cannot start an organization.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
429`rate_limited`: the person started 5 organizations in the last 24 hours, the one made at sign-up included. Nothing was created. Please try again later.Error

Example

curl example for POST /v1/me/organizations
curl -X POST https://api.evictionsapi.com/v1/me/organizations \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Pat Landlord Rentals", "kind": "owner" }'

POST /v1/me/organizations/{id}/leave

Leave an organization. The person's other sessions acting for it are signed out; this one moves to their oldest remaining organization, or to none

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Responses

StatusMeaningBody
204The person left the organization.—
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
404`not_found`: the person is not an active member of that organization (the same answer whether or not it exists).Error
409`last_owner`: the person is the organization's last owner. Make someone else an owner first.Error
422The case did not pass a check.Error

Example

curl example for POST /v1/me/organizations/{id}/leave
curl -X POST https://api.evictionsapi.com/v1/me/organizations/case_.../leave \
  -H "Authorization: Bearer ess_..."

PATCH /v1/me/organizations/{id}

Choose which of the organization's case emails the person gets: `all`, `mine` (cases they opened) or `none`

Authentication: Session token, as Authorization: Bearer ess_...

Parameters

NameInTypeRequiredDescription
idpathstringYesThe case id.

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
caseEmailsstringYesOne of: "all", "mine", "none".

Responses

StatusMeaningBody
200The preference saved.{ id: string, caseEmails: string }
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
404`not_found`: the person is not an active member of that organization (the same answer whether or not it exists).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 PATCH /v1/me/organizations/{id}
curl -X PATCH https://api.evictionsapi.com/v1/me/organizations/case_... \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{ "caseEmails": "mine" }'

POST /v1/me/password

Change the person's password, with the current one. Every other session of the person is signed out (this one stays), and their pending email change and password reset links stop working

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
currentPasswordstringYes1 to 200 characters.
newPasswordstringYes10 to 200 characters.

Responses

StatusMeaningBody
204The password changed.—
400`invalid_request`: the new password is not 10 to 200 characters (`details.issues` names `newPassword`).Error
401The credential is missing or invalid.Error
403`account_kind`: the operator's and attorneys' accounts cannot change this here. `wrong_password`: the current password is not correct (5 wrong ones in 15 minutes lock the account, sign-in included). An API key or attorney token: `forbidden`.Error
404Not found.Error
409`no_password`: the account signs in with Google and has no password.Error
413The request body is too large.Error
422The case did not pass a check.Error
429`rate_limited`: 5 wrong current passwords for this account in 15 minutes; for an email change also more than 10 requests from one address in 10 minutes (counting `POST /v1/me/email/confirm`) or 3 links for the account in an hour. `Retry-After` gives the seconds to wait.Error
503`busy`: too many password checks are waiting. Nothing was changed. `Retry-After: 5` gives the seconds to wait; try again.Error

Example

curl example for POST /v1/me/password
curl -X POST https://api.evictionsapi.com/v1/me/password \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{
  "currentPassword": "your current password",
  "newPassword": "a new long password"
}'

POST /v1/me/email

Ask to change the person's email, with the current password. A link goes to the new address and the address changes only when it is opened; the old address is told

Authentication: Session token, as Authorization: Bearer ess_...

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
emailstringYesUp to 254 characters.
currentPasswordstringYes1 to 200 characters.

Responses

StatusMeaningBody
202The link was sent to the new address. It works once, for 24 hours, and a newer request replaces it.{ ok: boolean }
400`invalid_request`: not an email address, or an evictionsapi.com address (`details.issues` names `email`).Error
401The credential is missing or invalid.Error
403`account_kind`: the operator's and attorneys' accounts cannot change this here. `wrong_password`: the current password is not correct (5 wrong ones in 15 minutes lock the account, sign-in included). An API key or attorney token: `forbidden`.Error
404Not found.Error
409`email_taken`: an account with that address exists. `no_password`: the account signs in with Google and has no password.Error
413The request body is too large.Error
422The case did not pass a check.Error
429`rate_limited`: 5 wrong current passwords for this account in 15 minutes; for an email change also more than 10 requests from one address in 10 minutes (counting `POST /v1/me/email/confirm`) or 3 links for the account in an hour. `Retry-After` gives the seconds to wait.Error
503`busy`: too many password checks are waiting. Nothing was changed. `Retry-After: 5` gives the seconds to wait; try again.Error

Example

curl example for POST /v1/me/email
curl -X POST https://api.evictionsapi.com/v1/me/email \
  -H "Authorization: Bearer ess_..." \
  -H "Content-Type: application/json" \
  -d '{
  "email": "pat@new-domain.example",
  "currentPassword": "your current password"
}'

POST /v1/me/email/confirm

Change the email with the token from the link sent to the new address. No credential. The token works once

Authentication: none

Request body

JSON. Fields not listed are rejected.

NameTypeRequiredDescription
tokenstringYes1 to 200 characters.

Responses

StatusMeaningBody
200The account view, with the new address, confirmed. Sessions are kept; password reset links sent to the old address stop working. An `Idempotency-Key` header is ignored.{ user: object, organization: object | null, role: string, permissions: string[], organizations: object[], modes: object }
404`email_change_invalid`: the token is unknown, already used, replaced by a newer one or expired.Error
409`email_taken`: an account took that address meanwhile. Nothing changed.Error
413The request body is too large.Error
429`rate_limited`: at most 10 every 10 minutes from one address, counting `POST /v1/me/email` too. `Retry-After` gives the seconds to wait.Error

Example

curl example for POST /v1/me/email/confirm
curl -X POST https://api.evictionsapi.com/v1/me/email/confirm \
  -H "Content-Type: application/json" \
  -d '{ "token": "eec_..." }'

POST /v1/me/sessions/revoke-others

Sign out every other session of the person, keeping this one

Authentication: Session token, as Authorization: Bearer ess_...

Responses

StatusMeaningBody
200How many sessions were signed out.{ revoked: integer }
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/me/sessions/revoke-others
curl -X POST https://api.evictionsapi.com/v1/me/sessions/revoke-others \
  -H "Authorization: Bearer ess_..."

Response objects

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

PmsConnection

The organization's stored connection to a property-management system. Its credentials are kept encrypted and never returned.

NameTypeRequiredDescription
systemstringYesOne of: "buildium", "doorloop".
labelstringYesThe name the organization gave it; the system's name by default.
createdAtstringYesFormat: date-time.
lastUsedAtstring | nullYesFormat: date-time.
lastErrorstring | nullYesHow the last search or pull failed (`unauthorized`, `rate_limited`, `unavailable`); null when it worked.

LeaseMatch

A lease a search found, as the property-management system holds it. Empty strings where it has nothing to show.

NameTypeRequiredDescription
idstringYesThe system's lease id, for `pull`.
namestringNoThe system's own name for the lease (DoorLoop).
tenantsarray of stringYes—
unitstringYes—
addressstringYes—
startstringNoFormat: date.
endstringNoFormat: date.
balanceCentsintegerNoWhat the system says the tenant owes.

PmsPull

One lease read from the property-management system as suggested answers for a new case (each `{ value, source }`, the source being the system), the lease PDF when the system holds one, and the system's balance to check the ledger rows against. Nothing of it is stored: the person checks every answer.

NameTypeRequiredDescription
suggestionsobjectYes—
leaseFileobjectNo—
leaseFile.filenamestringIf leaseFile is sent—
leaseFile.contentBase64stringIf leaseFile is sent—
leaseFile.contentTypestringIf leaseFile is sentAlways "application/pdf".
balanceCentsintegerNo—
skippedRowsintegerNoHow many ledger rows were left out because their transaction type is not one we map. Absent when none.

IntakeFile

A file waiting in the organization's intake inbox for a case: a PDF, JPEG or PNG the customer already has, or the plain text of a forwarded email. It waits 30 days, then is deleted unless it was moved onto a case.

NameTypeRequiredDescription
idstringYes—
sourcestringYesHow it arrived: forwarded by email, or sent through the API (an AI agent or an integration). One of: "email", "agent".
filenamestringYes—
contentTypestringYesDecided from the file's first bytes, never from its name. `text/plain` only for the text of a forwarded email, stored by us. One of: "application/pdf", "image/jpeg", "image/png", "text/plain".
purposeGuessstringYesWhat the file is probably for: as sent, or guessed from its name. Confirmed when it is moved onto a case. One of: "lease", "ledger", "correspondence", "other".
notestring | nullYesThe email's subject or the sender's note; null when none.
receivedAtstringYesFormat: date-time.
expiresAtstringYesWhen the file is deleted if it has not been moved onto a case. Format: date-time.

Case

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—
openedByobjectNoWho opened the case: the person (`id`, and their current display name, `null` when they have none), `{ "kind": "api_key" }` when it was opened with an API key, or `null` when that is not known (a case from before this was recorded).
landlordobject | nullNoThe owner your organization acts for on this case (one of `GET /v1/landlords`), with its current name; null when none was chosen, and always null on a test case. Set it with `landlordId` on `POST /v1/cases` or `PATCH /v1/cases/{id}` (live cases only).
landlord.idstringIf landlord is sent—
landlord.namestringIf landlord is sent—
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.

Document

NameTypeRequiredDescription
idstringYes—
kindstringYesOne of: "evidence", "notice", "filing", "proof", "other".
specIdstring | nullNo—
purposestringNoWhat an uploaded file (`kind: "evidence"`) is for, as given with the upload. Null for documents the platform or the attorney adds, and for files uploaded before purposes were kept. One of: "authority", "prior_notice", "prior_notice_proof", "other", "lease", "ledger", "correspondence", null.
filenamestringYes—
contentTypestringNoDecided from the file's first bytes when it was stored, never from its name. `text/plain` only for a `correspondence` document that is plain text (the body of a forwarded email). One of: "application/pdf", "image/jpeg", "image/png", "text/plain".
contentHashstringYesSHA-256 of the document bytes. An attorney approval names these.
createdAtstringNoFormat: date-time.

GateResults

NameTypeRequiredDescription
passedbooleanYes—
resultsarray of objectYes—
results[].gatestringYes—
results[].statusstringYes—
results[].reasonstringNo—
missingarray of stringNoWhat the checks still miss, by name: field paths (`lease.monthlyRentCents`), and `parties.plaintiff`, `parties.defendant` or `ledger.kind` (the kind of each ledger charge). Never a value.
missingReasonsobjectNoA draft only: for an item of `missing` that was looked for in your documents or saved details and not filled, why (`code`, as in the case's `documentFill.reasons`) and what to do, in one sentence (`message`). No value of the case is in it.
filledFromDocumentsarray of stringNoThe field paths of the answers read from the case's own uploaded documents (`sources` kind `document_read`). Check each before submitting.

Task

One outward step of a full-service case (`handling: "agent_filed"`): delivering the notice, filing, ordering the summons, attending the hearing, a signature from the owner, or mail from the court.

NameTypeRequiredDescription
kindstringYesOne of: "notice_delivery", "filing", "summons_order", "hearing_appearance", "client_signature", "court_mail".
statusstringYesOne of: "pending", "in_progress", "done", "failed", "cancelled".
dueAtstring | nullYesWhen the step must be done by, when there is a deadline. Format: date-time.
completedAtstring | nullYesFormat: date-time.

CaseGaps

NameTypeRequiredDescription
idstringYes—
unavailablebooleanNoPresent when the checks could not be run on this draft as it stands: its gaps are not known, and it cannot be submitted until that is put right. Always true.
propertyobjectYes—
property.line1stringYes—
property.unitstringNo—
property.citystringYes—
property.statestringYes—
gapsarray of objectYes—
gaps[].codestringYesThe failing check (`ledger_reconciles.rent_owed`, `authority.document`), or `missing` for a detail still asked for.
gaps[].fieldstringNoFor `missing`: the detail, by its case-data path (or `parties.plaintiff`, `parties.defendant`, `ledger.kind`).
gaps[].reasonstringNoFor `missing`: why it was not filled from your documents or saved details, as a code (see the case's `documentFill.reasons`).
gaps[].messagestringYes—
gaps[].actionobject | nullYes—
gaps[].action.typestringYesOne of: "open_field", "upload", "apply".
gaps[].action.labelstringYes—
gaps[].action.fieldstringNo—
gaps[].action.purposestringNoOne of: "ledger", "authority", "prior_notice", "prior_notice_proof".
gaps[].action.codestringNoOne of: "amount_owed", "rent_owed".
gaps[].action.shownCentsintegerNo—
gaps[].secondaryobjectNo—
gaps[].secondary.typestringIf gaps[].secondary is sentAlways "open_field".
gaps[].secondary.labelstringIf gaps[].secondary is sent—
gaps[].secondary.fieldstringNo—

ManagedFacts

NameTypeRequiredDescription
actionstringYesThe proposed act the answer is about.
declaredbooleanYesWhether the customer declared these facts, and not only a suggestion.
declaredAtstring | nullYesWhen the customer declared them last. Format: date-time.
problemstring | nullYesWhy the stored facts do not read as a complete declaration.
missingarray of objectYesThe facts this act is missing, each with the question to ask. An empty list is not permission to perform the act.
missing[].keystringYes—
missing[].questionstringYes—
sourcesobjectYesWhere each declared fact came from: the source of the last write that set it, `customer` or `suggestion`. A fact that is absent was never declared by anyone.
notestringYes—

Authorization

The authorization the owner signs for an agent-filed case: the text to sign now, the signature in force for it, and whether the case facts changed after it was signed. A change to the facts makes the signature stale until the owner signs again.

NameTypeRequiredDescription
textVersionstringYesThe version of the text, recorded with every signature.
textstringYesThe text the owner signs: plain text, numbered paragraphs.
signedobject | nullYes—
signed.atstringYesFormat: date-time.
signed.signerNamestringYes—
signed.recordedobject | nullYesSet when the owner gave the authorization to our staff orally (by telephone, text message, in person or email) and our staff recorded it on the owner's instruction: how and on what day. Null for an authorization signed here.
signed.recorded.channelstringYesOne of: "phone", "message", "in_person", "email".
signed.recorded.onstringYesFormat: date.
stalebooleanYesTrue when the facts changed after the signature. The case does not proceed until it is signed again.

Signature

A signature the owner just gave. The IP address it was given from is kept only as a hash, and is not shown.

NameTypeRequiredDescription
idstringYes—
kindstringYesOne of: "authorization", "complaint".
textVersionstringYes—
signerNamestringYes—
signerTitlestring | nullYes—
signedAtstringYesFormat: date-time.

ComplaintToSign

The complaint documents the owner signs where the county requires the owner to sign the complaint itself, and whether exactly this set is signed.

NameTypeRequiredDescription
documentsarray of objectYes—
documents[].idstringYes—
documents[].filenamestringYes—
documents[].contentHashstringYes—
signedbooleanYes—
swornobjectNoPresent where the court filing is an affidavit your named person swears under oath by electronic verification in the app (Georgia: O.C.G.A. § 15-10-53(d)(4)). `affiantName` is the name the affidavit prints, which the signer types; `date` is the day it is dated if sworn now (null once sworn); `documents` are the documents exactly as they will be filed if sworn now, signed and dated (download each from `GET /v1/cases/{id}/signatures/complaint/documents/{specId}`; empty once sworn). Send their `contentHash` values as `documentHashes` when signing.
sworn.affiantNamestringIf sworn is sent—
sworn.datestring | nullIf sworn is sentFormat: date.
sworn.documentsarray of objectIf sworn is sent—
sworn.documents[].specIdstringIf sworn is sent—
sworn.documents[].filenamestringIf sworn is sent—
sworn.documents[].contentHashstringIf sworn is sent—

Event

NameTypeRequiredDescription
idstringYes—
actionstringYes—
actorTypestringYes—
fromStatestring | nullYes—
toStatestring | nullYes—
detailanyNo—
createdAtstringYesFormat: date-time.

Charge

An amount owed to the platform for a case: the platform fee, or court or service costs passed on at cost. The attorney's legal fee is never a charge here: it is separate and paid to the attorney.

NameTypeRequiredDescription
idstringYes—
kindstringYesOne of: "platform_fee", "court_costs", "service_costs", "other".
descriptionstringYes—
amountCentsintegerYesUS cents.
statusstringYesOne of: "due", "paid", "void", "refunded".
collectionstringYesHow the charge is paid. `checkout`: on the payment page (`POST /v1/cases/{id}/charges/{chargeId}/checkout`). `automatic`: a cost of a full-service case, taken from a saved card (`/v1/payment-methods`); it is never paid by checkout. One of: "checkout", "automatic".
paidAtstring | nullYesFormat: date-time.
receiptUrlstring | nullYesThe payment provider's public receipt page for a paid charge, kept shortly after the payment is recorded. Null until then, when it could not be read, and for charges paid before receipt links were kept (their receipt was sent by email). Format: uri.
createdAtstringYesFormat: date-time.

Card

One of the organization's saved cards for the automatic charges of full-service cases, in the key's mode. The card number is never stored: only its brand, last four and expiry, and the cardholder's name as the payment service has it. A case is charged to the card it names (`paymentMethodId`), else to the default card. `failed`: the card was declined; it is not charged again, and cannot be made the default.

NameTypeRequiredDescription
idstringYes—
brandstring | nullYes—
lastFourstring | nullYes—
statusstringYesOne of: "usable", "failed".
labelstring | nullYesWhat the organization calls the card, such as "Operating account card"; null when unnamed.
isDefaultbooleanYesThe card charged when a case names none. One card per mode at most.
addedByobject | nullYesThe person who added it (for a card kept from a checkout: the person who paid); null for a card added with an API key, or before this was kept.
addedBy.idstringYes—
addedBy.namestring | nullYes—
createdAtstringYesFormat: date-time.
cardholderNamestring | nullYesThe cardholder's name as the payment service has it; null when it was not given.
expMonthinteger | nullYesThe card's expiry month, 1 to 12.
expYearinteger | nullYesThe card's expiry year.
landlordobject | nullYesThe saved landlord (owner) the organization says the card is for (`PATCH /v1/payment-methods/{id}` with `landlordId`); null when it is linked to none. A card kept from the checkout of a case that names a landlord is linked to that landlord.
landlord.idstringYes—
landlord.namestringYes—
firstCaseIdstring | nullYesThe case whose checkout the card was kept from; null for a card saved on the card page.

CustomerCharge

A charge on one of the organization's cases, as the billing page lists it: the case's id, the property's state and the case's landlord, and the charge as `GET /v1/cases/{id}/charges` shows it.

NameTypeRequiredDescription
idstringYes—
caseIdstringYes—
propertyStatestringYesTwo-letter code of the property's state. Empty for a case whose details were erased.
landlordobject | nullYesThe case's landlord (one of `GET /v1/landlords`, archived ones too) with its current name; null when the case has none.
landlord.idstringYes—
landlord.namestringYes—
kindstringYesOne of: "platform_fee", "court_costs", "service_costs", "other".
descriptionstringYes—
amountCentsintegerYesUS cents.
statusstringYesOne of: "due", "paid", "void", "refunded".
collectionstringYesAs on `Charge`. One of: "checkout", "automatic".
paidAtstring | nullYesFormat: date-time.
receiptUrlstring | nullYesAs on `Charge`. Format: uri.
createdAtstringYesFormat: date-time.

ChargeTotals

The billing page's totals over all the organization's charges in the mode, whatever the filter, in US cents. Years are UTC calendar years. "Refunded this year" counts charges by the day they were refunded.

NameTypeRequiredDescription
dueCountintegerYes—
dueCentsintegerYes—
paidLast30CentsintegerYes—
paidThisYearCentsintegerYes—
refundedThisYearCentsintegerYes—

Landlord

An owner the organization acts for, as a property manager: a profile reused across cases, never an account. It belongs to the organization, whatever the mode, and only live cases take one: a live key and a signed-in person see it, a test key never does. An archived landlord keeps its cases and is hidden from `GET /v1/landlords` unless `includeArchived=true`. At most 1,000 per organization, archived ones included.

NameTypeRequiredDescription
idstringYes—
namestringYes—
isEntitybooleanYesA company, trust or other entity rather than a person.
plaintiffTypestringYesThe legal type of the plaintiff, as the full service asks it; null when not given. One of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other", null.
ownerOfRecordstringYesThe owner of record of the properties; the name unless given.
contactobjectYes—
contact.addressstringYes—
contact.phonestringYes—
contact.emailstring | nullYesFormat: email.
notesstring | nullYesThe organization's own notes; never on a court document.
archivedbooleanYes—
caseCountintegerYesHow many of the organization's cases in the key's mode name this landlord.
createdAtstringYesFormat: date-time.
updatedAtstringYesFormat: date-time.

LandlordDocument

A landlord's management agreement, without its contents. A PDF, JPEG or PNG, decided from the file's first bytes.

NameTypeRequiredDescription
idstringYes—
filenamestringYes—
contentTypestringYesOne of: "application/pdf", "image/jpeg", "image/png".
uploadedAtstringYesFormat: date-time.

PaymentMethod

The default card for the automatic charges of full-service cases, in the key's mode, as the older `/v1/payment-method` routes show it: its brand and last four only. `failed`: the card was declined, and the cases waiting on a payment stay on hold until a card that works is saved.

NameTypeRequiredDescription
brandstring | nullYes—
lastFourstring | nullYes—
statusstringYesOne of: "usable", "failed".

Note

A message on a case, between the customer and the platform.

NameTypeRequiredDescription
idstringYes—
authorstringYesOne of: "operator", "customer".
bodystringYes—
createdAtstringYesFormat: date-time.