GuidesAPI ReferenceFAQ
API Reference

list virtual keys

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

Virtual keys provide temporary access to guests. Please see the
Keychain documentation for more details.

A guest can be sent a Virtual Key via email or via SMS.

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 name (case insensitive)

string

filter by name starts with (case insensitive)

string

filter by exact match on email (case insensitive)

string

filter by email starts with (case insensitive)

string

filter by exact match on SMS number (case insensitive)

string

filter by SMS number starts with (case insensitive)

string

filter by exact match on keychain id

q[keychain_id_in][]
array of integers

filter by keychain id in list

q[keychain_id_in][]
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][]
q[id_in][]
array of integers

filter by id in list

q[id_in][]
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