GuidesAPI ReferenceFAQDiscussions
API Reference
Start typing to search…

list devices

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

A Device is a physical device that is installed in a building,
through which one can control access to one or multiple
Access Points, to an amenity like the KeyLocker, or to common rooms
controlled by devices from 3rd parties.

Log in to see full request history
Query Params
integer
≥ 0

requested page

integer
1 to 100

page size

string

filter by exact match on type (case insensitive)

string

filter by exact match on name (case insensitive)

string

filter by name starts with (case insensitive)

string

filter by exact match on serial number (case insensitive)

string

filter by serial number starts with (case insensitive)

string

filter by exact match on building_id (case insensitive)

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 9 days ago

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

Updated 9 days ago