# Get your Yardi Voyager tenants and units through an API

> Read a tenant's tenancy status and lease dates, a unit's status and Date Available, or the rows of a saved Voyager report with one API call. Or have a workflow send you every Monday's list of units on notice and vacant not ready.

Page: https://fous.com/automate/yardi-voyager
Updated: 2026-11-12

Works with your own Yardi Voyager account. Fous is an independent product.

## What you can build on Voyager

### Get a tenant record

Opens Tenant > Review Tenant for a property and unit and reads the tenant screen: tenancy status, move-in and lease dates.

- Takes: Property, unit
- Returns: Tenant ID, tenant name, tenancy status, move-in date, lease from, lease to, term in months, move-out date

### Check unit status

Opens Unit > Review Unit for one unit and reads its unit status and, on the Occupancy tab, its Date Available.

- Takes: Property, unit
- Returns: Unit, property, unit status, date available

### Run a saved Voyager report

Runs a custom report you saved in Voyager's report builder, with the filters you pass, and returns its rows.

- Takes: Report name, property, filters (optional)
- Returns: One row per record with the report's own columns, report name, run date

### Place a tenant on notice

From the tenant screen, selects Functions > Notice, fills in the notice and saves it, so the tenancy status moves to Notice.

- Takes: Property, unit, termination type, notice date, move-out date, reason for move-out
- Returns: Tenant ID, tenancy status, notice date, move-out date

## Automate Voyager with a workflow

A [workflow](/product/workflows) runs your methods as one process, with nobody at the screen. A schedule or a call from your own system starts it, the steps run in order, and the result arrives in your inbox or in the systems you already use.

### Units on notice and vacant not ready, every Monday

Starts: Every Monday at 7:00

1. For each property and unit you list, check the unit status and Date Available.
2. Keep the units in Notice Unrented, Vacant Unrented Not Ready or Vacant Rented Not Ready.
3. Email you the list, one section per property, with each unit's Date Available.

### Tenancy status changes, posted to your system

Starts: Every weekday at 8:00

1. For each property and unit you list, get the tenant record.
2. Keep the tenants whose tenancy status or move-out date changed since the last run.
3. Post each change to your ERP or Slack webhook.

### Saved report rows, delivered to your warehouse

Starts: Every weekday at 6:00

1. Run the saved Voyager report you name for each property.
2. Stop when it returns no rows.
3. Post the rows, with the property and run date, to your warehouse webhook.

You can run a workflow by hand on every plan, Free included. Schedules and webhook triggers come with the paid plans, from $29 a month.

## Once built, one call from your code

Once you have built a [method](/product/methods), it is one POST to /v1/runs from your backend, or a tool an AI agent calls over MCP. This is what “Get a tenant record” would look like.

Example request:

```
curl https://api.fous.com/v1/runs \
  -H "Authorization: Bearer $FOUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "yardione.com/get_tenant_record",
    "input": {
      "property": "Northwind Commons",
      "unit": "214"
    }
  }'
```

Example response:

```
{
  "status": "completed",
  "data": {
    "tenant_id": "t0048213",
    "tenant_name": "Acme Example Household",
    "tenancy_status": "Notice",
    "move_in_date": "2024-08-01",
    "lease_from": "2025-08-01",
    "lease_to": "2026-07-31",
    "term_months": 12,
    "move_out_date": "2026-11-30"
  }
}
```

An example with invented data, not a ready-made endpoint. The method exists in your organization once you build it, and its name, inputs and fields follow your request.

## Voyager’s own options

Yardi offers its API through the Yardi Interfaces Program, which software vendors join: a Data Exchange Agreement for each interface type and an annual license fee per interface. As a Voyager client, you can use one of the 450+ standard interface partners, or build and save custom reports inside Voyager and rerun them.

| Option | What it covers | What it takes |
| --- | --- | --- |
| Yardi Interfaces Program (Yardi API) | Yardi's API for the partner's interface, a development sandbox for Standard Interface vendors, and Yardi technical support. | A Data Exchange Agreement per interface type and an annual fee per interface. Standard Interface vendors: 2 years in business, 3 active Voyager clients. |
| Standard interface partners | 450+ vendors connected through APIs such as Receivables, Payables, Master Data, Maintenance, Commercial, Screening and Collections. | A product from one of the vendors on Yardi's interface partner list. |
| Custom report builder | Drag-and-drop reports on property, unit, prospect and resident data, with filters, saved and rerun, plus built-in industry-standard reports. | Your Voyager user account. |
| Voyager in the browser | Everything your role can see and do: Review Tenant, Review Unit, notices, move-outs and reports. | A user account in your organization's Voyager, opened from the YardiOne dashboard. |

Read on November 12, 2026: [Yardi: Become an interface partner](https://www.yardi.com/company/become-an-interface-partner/), [Yardi: Find an interface partner](https://www.yardi.com/company/find-an-interface-partner/), [Yardi: Voyager Residential](https://www.yardi.com/product/voyager-residential/).

## Signing in to Voyager

You sign in to the YardiOne dashboard with your email address and password, then open the Voyager tile. In one published client guide, YardiOne's multi-factor authentication emails a one-time code. With Fous you sign in through YardiOne with your own account, and an emailed code is handled. When a session expires, Fous signs back in.

## Worth knowing

- **Unit status and tenancy status are separate**: A unit has a unit status, such as Occupied No Notice or Vacant Unrented Not Ready, and its tenant has a tenancy status: Future, Current, Notice, Past or Cancelled. Ask for the one you need.
- **Pick the right YardiOne tile**: YardiOne can show several tiles, such as a Voyager Training practice environment next to live Voyager. Name the live tile when you build a method, so it reads production data.
- **Move-outs follow an order**: A tenant must be Current to be placed on notice, and a move-out can be posted only after the notice. Posting it moves the tenancy status to Past.
- **Screens follow your organization's setup**: Your Voyager screens can differ from another client's. One client's guide adds an RGI tab to the tenant screen and a Subsidy and Vacancy Tracking table to units, so describe the screens as you see them.

## More in Real estate: property management and listings

- [レインズ](https://fous.com/automate/reins.md)
- [HomeWiseDocs](https://fous.com/automate/homewisedocs.md)
- [Bright MLS](https://fous.com/automate/bright-mls.md)
- [CRMLS](https://fous.com/automate/crmls.md)
- [Flexmls](https://fous.com/automate/flexmls.md)
- [Matrix](https://fous.com/automate/matrix.md)
- [Paragon MLS](https://fous.com/automate/paragon-mls.md)
- [Ignite](https://fous.com/automate/ignite.md)
- [PF Expert](https://fous.com/automate/pf-expert.md)
- [Rightmove Plus](https://fous.com/automate/rightmove-plus.md)
- [ZooplaPro](https://fous.com/automate/zooplapro.md)
- [AppFolio Property Manager](https://fous.com/automate/appfolio-property-manager.md)
- [Buildium](https://fous.com/automate/buildium.md)
- [Entrata](https://fous.com/automate/entrata.md)
- [PropertyMe](https://fous.com/automate/propertyme.md)
- [Rental Bonds Online](https://fous.com/automate/rental-bonds-online.md)
- [RTBA Online](https://fous.com/automate/rtba-online.md)
- [ShowingTime](https://fous.com/automate/showingtime.md)
- [Deposit Protection Service](https://fous.com/automate/deposit-protection-service.md)
- [Tenancy Deposit Scheme](https://fous.com/automate/tenancy-deposit-scheme.md)

Other industries: [LeadsOnline](/automate/leadsonline), [1WorldSync Item Management](/automate/1worldsync-item-management), [Cenconline B2B](/automate/cenconline-b2b), [T-Mobile for Business Account Hub](/automate/t-mobile-for-business-account-hub), [Reece maX](/automate/reece-max), [Petronect](/automate/petronect).

## Frequently asked questions

### Does Yardi Voyager have an API?

Yes, through the Yardi Interfaces Program, which software vendors join with a Data Exchange Agreement per interface type and an annual fee per interface. As a client, you use it through one of the 450+ standard interface partners, or you build and rerun custom reports inside Voyager.

### Is Fous affiliated with Yardi Systems?

No. Fous is an independent product. You sign in to Voyager with your own account, and a method reads and does only what that account can.

### Can I get the rows of a report I already saved in Voyager?

Yes. Voyager lets you save custom reports and rerun them, so you can build a method that runs your saved report with the filters you pass and returns each row as JSON with the report's own columns.

### We have several properties. Does one method cover all of them?

Yes, when your account can see them. Pass the property as an input, and use a workflow's loop to run the method for each property and unit you list.

### What happens when our Voyager screens change after an upgrade?

Fous repairs the method when the site changes its pages, so your calls keep returning the same fields.

Fous is an independent product: it is not affiliated with, endorsed by or sponsored by the operator of Yardi Voyager (Yardi Systems). The name is used only to say which system this page is about. Something here wrong or out of date? Write to legal@fous.com.