GuidesAPI ReferenceFAQ
API Reference

list tenants

get
https://api.butterflymx.com/v4/tenants

A Tenant is a person living in a unit.

Tenants are the primary way to manage people in a building, and therefore
access to the building.

A Tenant can have one or more Access Tools
with which they gain permanent access to the building.

A Tenant can also
create Virtual Keys which they can share with other people to grant
them temporary access to the building.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0

requested page

integer
1 to 100

page size

string

filter by exact match on full name (case insensitive)

string

filter by full name starts with (case insensitive)

string

filter by exact match on first name (case insensitive)

string

filter by first name starts with (case insensitive)

string

filter by exact match on last name (case insensitive)

string

filter by last name starts with (case insensitive)

string

filter by exact match on building id

q[building_id_in][]
array of integers

filter by building id in list

q[building_id_in][]
string

filter by exact match on unit id

q[unit_id_in][]
array of integers

filter by unit id in list

q[unit_id_in][]
q[id_in][]
array of integers

filter by id in list

q[id_in][]
string

filter by current user

Responses

Updated about 1 month ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago