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.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 0

requested page

per

integer

1 to 100

page size

q[name_eq]

string

filter by exact match on name (case insensitive)

q[name_start]

string

filter by name starts with (case insensitive)

q[email_eq]

string

filter by exact match on email (case insensitive)

q[email_start]

string

filter by email starts with (case insensitive)

q[sms_number_eq]

string

filter by exact match on SMS number (case insensitive)

q[sms_number_start]

string

filter by SMS number starts with (case insensitive)

q[keychain_id_eq]

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

q[building_id_eq]

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

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.butterflymx.com/v4/virtual_keys \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200fetch all virtual keys that your user can see

401unauthorized