---
title: "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"
method: POST
path: "/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

`POST /v1/integrations/{system}/pull`

## Request

- Base URL: `https://api.evictionsapi.com`
- URL: `https://api.evictionsapi.com/v1/integrations/{system}/pull`
- Auth: HTTP bearer

## Path parameters

- `system` 'buildium' | 'doorloop', required

## Request body

- object
  - `leaseId` string, required

## Response `200`

The lease's suggested answers.

- 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.
  - `suggestions` object, required
  - `leaseFile` object
    - `filename` string, required
    - `contentBase64` string, byte, required
    - `contentType` 'application/pdf', required
  - `balanceCents` integer
  - `skippedRows` integer: How many ledger rows were left out because their transaction type is not one we map. Absent when none.

## Other responses

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

---

[API](https://skmtc.dev/evictionsapi/apis/evictions-api.md) · [All operations](https://skmtc.dev/evictionsapi/apis/evictions-api/llms.txt) · [OpenAPI document](https://skmtc.dev/evictionsapi/apis/evictions-api/revisions/28459213a1a3?raw)