ButterflyMX API V3

API Endpoint

OAuth2 Authentication

The ButterflyMX API V3 implements the Authorization Grant Type Flow and issues an access_token along with a refresh_token. The Authorization Code grant type is used by confidential and public clients to exchange an authorization code for an access token.

Obtaining an authorization code (Authentication)

To begin the authorization flow, your application will need to construct a URL like the following and open a browser to that URL: https://accountssandbox.butterflymx.com/oauth/authorize?client_id=$CLIENT_ID&redirect_uri=https://usersandbox.butterflymx.com/oauth/callbacks/butterflymx&response_type=code&client_secret=$CLIENT_SECRET

Obtaining an access_token

To obtain a valid access_token and refresh_token, your application will need to send the $CLIENT_ID, $CLIENT_SECRET and $code to the ButterflyMX token endpoint:

curl --location --request POST 'https://accountssandbox.butterflymx.com/oauth/token' \
--form 'grant_type=authorization_code' \
--form 'code=$code' \
--form 'client_id=$CLIENT_ID' \
--form 'client_secret=$CLIENT_SECRET' \
--form 'redirect_uri=https://usersandbox.butterflymx.com/oauth/callbacks/butterflymx'

Response sample in case of success:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "access_token": "eyJ0eXAi...TcV3Q",
    "token_type": "bearer",
    "expires_in": 7200,
    "refresh_token": "6d8cd1d...9f75",
    "created_at": 1506068201
}

Response sample in case that your $CLIENT_ID doesn’t exist, or you didn’t include your $CLIENT_SECRET in the request:

{
  "error": "invalid_client",
  "error_description": "Client authentication failed due to unknown client, no client authentication included, or unsupported authentication method."
}

Renewal of the access_token

After access_token expiration, an app can call the same API authentication endpoint to exchange the refresh_token for a new, valid access_token:

curl -X POST "https://accountssandbox.butterflymx.com/oauth/token" \
  -d grant_type=refresh_token \
  -d refresh_token=6d8cd1d...9f75 \
  -d client_id=$CLIENT_ID \
  -d client_secret=$CLIENT_SECRET

Response sample in case of success:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "access_token": "eyJ0eXAi...",
    "token_type": "bearer",
    "expires_in": 7200,
    "refresh_token": "6d8cd1d...",
    "created_at": 1506068601
}

Note: After successful refresh action, the mobile app has to store new access_token and refresh_token (both are changed)!

Last issued refresh_token doesn’t expire (it is valid indefinitely) but is still subject to invalidation for other reasons. In case that on the renewal request server responds with HTTP status 401, the app should immediately log-off user.

Response status 401, in this case, means that this refresh_token is invalid and refresh operation will not be possible. For example, if the mobile phone is stolen or compromised, the refresh_token can be invalidated on the server side.

User Password Change

Users can change their password by sending a PUT or PATCH request to the ButterflyMX Accounts API. All password change requests need to include the access_token in the Authorization header like this:

curl -X PUT 'https://accounts.butterflymx.com/api/v1/password' \
  -H 'Authorization:Bearer eyJ0eXAi...TcV3Q' \
  --data-urlencode 'account[current_password]=password' \
  --data-urlencode 'account[password]=new_password' \
  --data-urlencode 'account[password_confirmation]=new_password'

In case of the successful password change, the server will return HTTP status 204 No Content.

In case that current password was not correct, the server will respond with a ‘Wrong password’ message in the errors key, like this:

HTTP/1.1 422 Unprocessable Entity
  Content-Type: application/json

  { "errors" : "Wrong password" }

In case of any other errors while updating password, full error messages will be returned. The most common (and probably only) case where this could happen is when there is a password and password_confirmation values mismatch, like this:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{ "errors" : ["Password confirmation doesn't match Password"] }

User Roles

Authenticated user can have any of the following roles (authorizations):

  • Tenant

  • Unit Admin

  • Zone Admin

  • Building Admin

Data Models

ButterflyMX Building model is divided into zones (e.g., residential, business, etc.). Zones can’t overlap. Each zone can contain many units. A unit can be apartment, office, garage, etc.

  • building has many zones

  • zone belongs to only one building

  • zone has many units

  • unit belongs to only one zone

  • user can be a tenant in many units

  • unit can have many tenants (users)

Building Data Model

JSON API Specification

ButterflyMX API V3 implements latest JSON API Specification (v1.0) published at: http://jsonapi.org/format/

Pagination

Pagination use query parameters such as page[number] and page[size].

For example:

GET https://apisandbox.butterflymx.com/v3/door_releases?page[size]=10&?page[number]=2
Accept: application/vnd.api+json

Sorting

Note: Examples are not url-encoded for a better readability

Example:

GET https://apisandbox.butterflymx.com/v3/door_releases?sort=name,created_at
Accept: application/vnd.api+json

Multiple Sort You can sort on multiple fields like this:

GET https://apisandbox.butterflymx.com/v3/door_releases?sort=name,created_at
Accept: application/vnd.api+json

Descendant Sort Note: The sort order for each attribute is ascending unless it is prefixed with a minus (U+002D HYPHEN-MINUS, -), in which case it is descending.

You can make desc sort with the character - like this:

GET https://apisandbox.butterflymx.com/v3/door_releases?sort=-created_at
Accept: application/vnd.api+json

Multiple Sort with Descendant Sort

GET https://apisandbox.butterflymx.com/v3/door_releases?sort=-created_at,name
Accept: application/vnd.api+json

The above example should return the newest door releases first. Any door release created on the same moment then be sorted by their name in ascending alphabetical order.

Filtering

Examples:

GET https://apisandbox.butterflymx.com/v3/door_releases?filter[unit]=11
Accept: application/vnd.api+json

or

GET https://apisandbox.butterflymx.com/v3/door_releases?filter[unit]=11&filter[user]=22
Accept: application/vnd.api+json

Check each resource to see which fields can be filtered.

Some endpoints can have other resources included, check the endpoint documentation to see which resources can be included for that endpoint.

Example:

GET https://apisandbox.butterflymx.com/v3/me?include=buildings,units
Accept: application/vnd.api+json

You can read more about includes here

Buildings

Buildings

Note: symbol ✓ marks permission on all entries in the authorized scope (e.g. all buildings where the Building Admin is authorized for administration* etc.)

List / Show Change Create Delete
Tenant - - - -
Unit Admin - - - -
Zone Admin - - - -
Building Admin ✓ ✓ - -

Fields that can be changed by the building admin:

  • name (String)

  • time_zone (String)

  • building_type (String)

  • display_name_strategy (String), one of the allowed values:

    • building
    • custom
    • first_name_and_last_name
    • first_name_initial_and_last_name
    • anonymous
    • first_name_and_last_name_initial

  • send_panel_status_report (Boolean)

  • panel_logo (File)

  • mobile_logo (File)

  • remove_panel_logo (Boolean)

  • remove_mobile_logo (Boolean)

  • qr_key_enabled (Boolean)

  • door_release_pin (String)

  • in_unit_phone_number (String)

  • address_1 (String)

  • address_2 (String)

  • city (String)

  • state (String)

  • zip_code (String)

  • phone_number (String)

  • country (String)

GET /v3/buildings
Requestsreturns the list of the buildings

GET  /v3/buildings

Headers
Accept: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "13",
      "type": "buildings",
      "attributes": {
        "name": "Grant-Kertzmann-13",
        "building_type": "multi_family",
        "display_name_strategy": "first_name_initial_and_last_name",
        "qr_key_enabled": true,
        "nfc_enabled": false,
        "send_panel_status_report": false,
        "mobile_logo_picture": {
          "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
          "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
        },
        "panel_logo_picture": {
          "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
          "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
        },
        "address_1": "1008 Bruno Mews",
        "address_2": "Port Theofort, VT 21274-3252",
        "city": "Port Theofort",
        "state": "Vermont",
        "zip_code": "21274-3252",
        "phone_number": "121.242.1850 x348",
        "country": "us",
        "time_zone": "Etc/UTC",
        "time_zone_offset": "+00:00",
        "delivery_pass_enabled": true,
        "door_release_pin": true,
        "open_door_button_enabled": true
      },
      "relationships": {
        "panels": {
          "data": [
            {
              "id": "4",
              "type": "panels"
            }
          ]
        },
        "key_lockers": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "4",
      "type": "panels",
      "attributes": {
        "name": "Duncan Idaho 4",
        "nfc": {
          "uuid": "fb15947e-4d75-462b-96af-61bd5ae4cc57"
        }
      },
      "relationships": {
        "building": {
          "data": {
            "id": "13",
            "type": "buildings"
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/buildings?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/buildings?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/buildings?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

List
GET/v3/buildings

GET /v3/buildings/16
Requestsreturns the building datareturns the associated KeyLockers

GET  /v3/buildings/16

Headers
Accept: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "16",
    "type": "buildings",
    "attributes": {
      "name": "Swift, Dicki and Doyle-16",
      "building_type": "multi_family",
      "display_name_strategy": "first_name_and_last_name_initial",
      "qr_key_enabled": true,
      "nfc_enabled": false,
      "send_panel_status_report": false,
      "mobile_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "panel_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "address_1": "50053 Block Square",
      "address_2": "Port Raymond, MI 36269-6490",
      "city": "Port Raymond",
      "state": "Michigan",
      "zip_code": "36269-6490",
      "phone_number": "289-480-2107 x1083",
      "country": "us",
      "time_zone": "Etc/UTC",
      "time_zone_offset": "+00:00",
      "delivery_pass_enabled": true,
      "door_release_pin": true,
      "open_door_button_enabled": true
    },
    "relationships": {
      "panels": {
        "data": [
          {
            "id": "5",
            "type": "panels"
          }
        ]
      },
      "key_lockers": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "5",
      "type": "panels",
      "attributes": {
        "name": "Hasimir Fenring 5",
        "nfc": {
          "uuid": "68e77768-93af-460a-b641-bfde91cec22d"
        }
      },
      "relationships": {
        "building": {
          "data": {
            "id": "16",
            "type": "buildings"
          }
        }
      }
    }
  ]
}

GET  /v3/buildings/19?include[]=key_lockers

Headers
Accept: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "19",
    "type": "buildings",
    "attributes": {
      "name": "Raynor-Bednar-19",
      "building_type": "multi_family",
      "display_name_strategy": "first_name_and_last_name",
      "qr_key_enabled": true,
      "nfc_enabled": false,
      "send_panel_status_report": false,
      "mobile_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "panel_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "address_1": "62770 Johnie Ports",
      "address_2": "Port Dustinmouth, WY 71104-6462",
      "city": "Port Dustinmouth",
      "state": "Wyoming",
      "zip_code": "71104-6462",
      "phone_number": "(704) 621-3107",
      "country": "us",
      "time_zone": "Etc/UTC",
      "time_zone_offset": "+00:00",
      "delivery_pass_enabled": true,
      "door_release_pin": true,
      "open_door_button_enabled": true
    },
    "relationships": {
      "panels": {
        "data": [
          {
            "id": "6",
            "type": "panels"
          }
        ]
      },
      "key_lockers": {
        "data": [
          {
            "id": "1",
            "type": "key_lockers"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "6",
      "type": "panels",
      "attributes": {
        "name": "Jessica Atreides 6",
        "nfc": {
          "uuid": "360a5c4b-bef6-4035-bd5c-9326e3d53798"
        }
      },
      "relationships": {
        "building": {
          "data": {
            "id": "19",
            "type": "buildings"
          }
        }
      }
    },
    {
      "id": "1",
      "type": "key_lockers",
      "attributes": {
        "name": "Shaddam Corrino IV 7"
      },
      "relationships": {
        "building": {
          "data": {
            "id": "19",
            "type": "buildings"
          }
        },
        "compartments": {
          "data": [
            {
              "id": "1",
              "type": "key_locker_compartments"
            },
            {
              "id": "2",
              "type": "key_locker_compartments"
            },
            {
              "id": "3",
              "type": "key_locker_compartments"
            },
            {
              "id": "4",
              "type": "key_locker_compartments"
            },
            {
              "id": "5",
              "type": "key_locker_compartments"
            },
            {
              "id": "6",
              "type": "key_locker_compartments"
            },
            {
              "id": "7",
              "type": "key_locker_compartments"
            },
            {
              "id": "8",
              "type": "key_locker_compartments"
            },
            {
              "id": "9",
              "type": "key_locker_compartments"
            },
            {
              "id": "10",
              "type": "key_locker_compartments"
            },
            {
              "id": "11",
              "type": "key_locker_compartments"
            },
            {
              "id": "12",
              "type": "key_locker_compartments"
            },
            {
              "id": "13",
              "type": "key_locker_compartments"
            },
            {
              "id": "14",
              "type": "key_locker_compartments"
            },
            {
              "id": "15",
              "type": "key_locker_compartments"
            },
            {
              "id": "16",
              "type": "key_locker_compartments"
            },
            {
              "id": "17",
              "type": "key_locker_compartments"
            },
            {
              "id": "18",
              "type": "key_locker_compartments"
            },
            {
              "id": "19",
              "type": "key_locker_compartments"
            }
          ]
        }
      }
    },
    {
      "id": "1",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "E8",
        "open": false,
        "full": true
      }
    },
    {
      "id": "2",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "N6",
        "open": false,
        "full": true
      }
    },
    {
      "id": "3",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "F2",
        "open": false,
        "full": true
      }
    },
    {
      "id": "4",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "B29",
        "open": false,
        "full": true
      }
    },
    {
      "id": "5",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "B13",
        "open": false,
        "full": true
      }
    },
    {
      "id": "6",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "W7",
        "open": false,
        "full": true
      }
    },
    {
      "id": "7",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "W14",
        "open": false,
        "full": true
      }
    },
    {
      "id": "8",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "Q9",
        "open": false,
        "full": true
      }
    },
    {
      "id": "9",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "F1",
        "open": false,
        "full": true
      }
    },
    {
      "id": "10",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "Q5",
        "open": false,
        "full": true
      }
    },
    {
      "id": "11",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "M33",
        "open": false,
        "full": true
      }
    },
    {
      "id": "12",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "T37",
        "open": false,
        "full": true
      }
    },
    {
      "id": "13",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "L39",
        "open": false,
        "full": true
      }
    },
    {
      "id": "14",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "Z41",
        "open": false,
        "full": true
      }
    },
    {
      "id": "15",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "I21",
        "open": false,
        "full": true
      }
    },
    {
      "id": "16",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "A40",
        "open": false,
        "full": true
      }
    },
    {
      "id": "17",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "F32",
        "open": false,
        "full": true
      }
    },
    {
      "id": "18",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "W22",
        "open": false,
        "full": true
      }
    },
    {
      "id": "19",
      "type": "key_locker_compartments",
      "attributes": {
        "cell": "T9",
        "open": false,
        "full": true
      }
    }
  ]
}

Show
GET/v3/buildings/{id}

URI Parameters
HideShow
id
number (required) Example: 16
PATCH /v3/buildings/42
Requestsupdates the building dataupdates the building addressdoes not update the building addressremoves the panel_logo

PATCH  /v3/buildings/42

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "buildings",
    "id": "42",
    "attributes": {
      "name": "My Building",
      "building_type": "commercial_office",
      "display_name_strategy": "first_name_and_last_name",
      "door_release_pin": false,
      "qr_key_enabled": false,
      "send_panel_status_report": true,
      "time_zone": "Eastern Time (US & Canada)"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "42",
    "type": "buildings",
    "attributes": {
      "name": "My Building",
      "building_type": "commercial_office",
      "display_name_strategy": "first_name_and_last_name",
      "qr_key_enabled": false,
      "nfc_enabled": false,
      "send_panel_status_report": true,
      "mobile_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "panel_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "address_1": "47132 Grimes Place",
      "address_2": "Lake Moshe, FL 18455",
      "city": "Lake Moshe",
      "state": "Florida",
      "zip_code": "18455",
      "phone_number": "684.101.4738",
      "country": "us",
      "time_zone": "Eastern Time (US & Canada)",
      "time_zone_offset": "-04:00",
      "delivery_pass_enabled": true,
      "door_release_pin": false,
      "open_door_button_enabled": true
    },
    "relationships": {
      "panels": {
        "data": [
          {
            "id": "7",
            "type": "panels"
          }
        ]
      },
      "key_lockers": {
        "data": []
      }
    }
  }
}

PATCH  /v3/buildings/45

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "buildings",
    "id": "45",
    "attributes": {
      "address_1": "New Building Address"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "45",
    "type": "buildings",
    "attributes": {
      "name": "Schoen-Hudson-64",
      "building_type": "multi_family",
      "display_name_strategy": "anonymous",
      "qr_key_enabled": true,
      "nfc_enabled": false,
      "send_panel_status_report": false,
      "mobile_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "panel_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "address_1": "New Building Address",
      "address_2": "Cristahaven, OH 63333-9761",
      "city": "Cristahaven",
      "state": "Ohio",
      "zip_code": "63333-9761",
      "phone_number": "604-879-6392 x031",
      "country": "us",
      "time_zone": "Etc/UTC",
      "time_zone_offset": "+00:00",
      "delivery_pass_enabled": true,
      "door_release_pin": true,
      "open_door_button_enabled": true
    },
    "relationships": {
      "panels": {
        "data": [
          {
            "id": "8",
            "type": "panels"
          }
        ]
      },
      "key_lockers": {
        "data": []
      }
    }
  }
}

PATCH  /v3/buildings/48

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "buildings",
    "id": "48",
    "attributes": {
      "address_1": ""
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/address.address_1"
      },
      "detail": "can't be blank"
    }
  ]
}

PATCH  /v3/buildings/51

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "remove_panel_logo": true
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "51",
    "type": "buildings",
    "attributes": {
      "name": "Parker, Jones and Feest-70",
      "building_type": "multi_family",
      "display_name_strategy": "first_name_and_last_name_initial",
      "qr_key_enabled": true,
      "nfc_enabled": false,
      "send_panel_status_report": false,
      "mobile_logo_picture": {
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb_small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium_small_picture.jpg"
      },
      "panel_logo_picture": {
        "thumb_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png",
        "medium_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png"
      },
      "address_1": "611 Prohaska Drive",
      "address_2": "Auerchester, MS 50346-7966",
      "city": "Auerchester",
      "state": "Mississippi",
      "zip_code": "50346-7966",
      "phone_number": "378.686.0376 x4087",
      "country": "us",
      "time_zone": "Etc/UTC",
      "time_zone_offset": "+00:00",
      "delivery_pass_enabled": true,
      "door_release_pin": true,
      "open_door_button_enabled": true
    },
    "relationships": {
      "panels": {
        "data": [
          {
            "id": "10",
            "type": "panels"
          }
        ]
      },
      "key_lockers": {
        "data": []
      }
    }
  }
}

Update
PATCH/v3/buildings/{id}

URI Parameters
HideShow
id
number (required) Example: 42

Integrations

Integrations

Allowed integrators:

  • webhook

Allowed config attributes for integrators:

  • webhook
    • url (String)
    • method (String get or post)

Allowed binding resource types:

  • call

  • door_release

GET /v3/buildings/1337/integrations
Requestsreturns a list of all the building's integrations

GET  /v3/buildings/1337/integrations

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "79c9dc15-1bef-4ecc-956e-824be46901ce",
      "type": "integrations",
      "attributes": {
        "integrator": "webhook",
        "config": {
          "method": "get",
          "url": "http://localhost:999"
        },
        "bindings": [
          {
            "resource_type": "door_release",
            "resource_id": "7",
            "actions": [
              "update",
              "destroy"
            ]
          }
        ]
      },
      "relationships": {
        "bindings": {
          "data": [
            {
              "resource_type": "door_release",
              "resource_id": "7",
              "actions": [
                "update",
                "destroy"
              ]
            }
          ]
        },
        "building": {
          "data": {
            "id": "1337",
            "type": "buildings"
          }
        },
        "tenant": {
          "data": null
        }
      },
      "links": {
        "self": "http://api.butterflymx.com/v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce"
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/buildings/1337/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "first": "http://api.butterflymx.com/v3/buildings/1337/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/buildings/1337/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

List
GET/v3/buildings/{building_id}/integrations

URI Parameters
HideShow
building_id
number (required) Example: 1337
GET /v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce
Requestsreturns a single integration for the building

GET  /v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "79c9dc15-1bef-4ecc-956e-824be46901ce",
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "config": {
        "method": "get",
        "url": "http://localhost:999"
      },
      "bindings": [
        {
          "resource_type": "door_release",
          "resource_id": "7",
          "actions": [
            "update",
            "destroy"
          ]
        }
      ]
    },
    "relationships": {
      "bindings": {
        "data": [
          {
            "resource_type": "door_release",
            "resource_id": "7",
            "actions": [
              "update",
              "destroy"
            ]
          }
        ]
      },
      "building": {
        "data": {
          "id": "1337",
          "type": "buildings"
        }
      },
      "tenant": {
        "data": null
      }
    },
    "links": {
      "self": "http://api.butterflymx.com/v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce"
    }
  }
}

Show
GET/v3/buildings/{building_id}/integrations/{id}

URI Parameters
HideShow
building_id
number (required) Example: 1337
id
string (required) Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
POST /v3/buildings/1337/integrations
Requestscreates an integration for the building

POST  /v3/buildings/1337/integrations

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Body
{
  "data": {
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "configuration": {
        "url": "http://localhost:666",
        "method": "post"
      },
      "bindings": [
        {
          "actions": [
            "create"
          ],
          "resource_type": "call",
          "resource_id": null
        }
      ]
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "79c9dc15-1bef-4ecc-956e-824be46901ce",
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "config": {
        "method": "post",
        "url": "http://localhost:666"
      },
      "bindings": [
        {
          "resource_type": "call",
          "resource_id": null,
          "actions": [
            "create"
          ]
        }
      ]
    },
    "relationships": {
      "bindings": {
        "data": [
          {
            "resource_type": "call",
            "resource_id": null,
            "actions": [
              "create"
            ]
          }
        ]
      },
      "building": {
        "data": {
          "id": "1337",
          "type": "buildings"
        }
      },
      "tenant": {
        "data": null
      }
    },
    "links": {
      "self": "http://api.butterflymx.com/v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce"
    }
  }
}

Create
POST/v3/buildings/{building_id}/integrations

URI Parameters
HideShow
building_id
number (required) Example: 1337
PATCH /v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce
Requestsupdates a building's integration

PATCH  /v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Body
{
  "data": {
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "configuration": {
        "url": "http://localhost:999",
        "method": "get"
      },
      "bindings": [
        {
          "actions": [
            "update",
            "destroy"
          ],
          "resource_type": "door_release",
          "resource_id": "7"
        }
      ]
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "79c9dc15-1bef-4ecc-956e-824be46901ce",
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "config": {
        "method": "get",
        "url": "http://localhost:999"
      },
      "bindings": [
        {
          "resource_type": "door_release",
          "resource_id": "7",
          "actions": [
            "update",
            "destroy"
          ]
        }
      ]
    },
    "relationships": {
      "bindings": {
        "data": [
          {
            "resource_type": "door_release",
            "resource_id": "7",
            "actions": [
              "update",
              "destroy"
            ]
          }
        ]
      },
      "building": {
        "data": {
          "id": "1337",
          "type": "buildings"
        }
      },
      "tenant": {
        "data": null
      }
    },
    "links": {
      "self": "http://api.butterflymx.com/v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce"
    }
  }
}

Update
PATCH/v3/buildings/{building_id}/integrations/{id}

URI Parameters
HideShow
building_id
number (required) Example: 1337
id
string (required) Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
DELETE /v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce
Requestsdeletes a building's integration

DELETE  /v3/buildings/1337/integrations/79c9dc15-1bef-4ecc-956e-824be46901ce

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Responses204
This response has no content.

Delete
DELETE/v3/buildings/{building_id}/integrations/{id}

URI Parameters
HideShow
building_id
number (required) Example: 1337
id
string (required) Example: 79c9dc15-1bef-4ecc-956e-824be46901ce

Current User

Status

Possible status values:

When call is VOIP:

  • initializing

  • canceled

  • timeout_online_signal

  • voip_connected

When call is mobile:

  • initializing

  • canceled

  • timeout_online_signal

  • connecting_sip

  • voip_rollover

  • rejected

GET /v3/me/calls/9326b0c1-b407-4fdf-b707-58ab5a6199bf/status
Requestsreturns status of the callreturns not found

GET  /v3/me/calls/9326b0c1-b407-4fdf-b707-58ab5a6199bf/status

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2",
    "type": "call_statuses",
    "attributes": {
      "status": "initializing",
      "multiple_devices": false,
      "created_at": "2022-07-26T09:34:49Z"
    },
    "relationships": {
      "call": {
        "data": {
          "id": "1",
          "type": "calls"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "calls",
      "attributes": {
        "guid": "9326b0c1-b407-4fdf-b707-58ab5a6199bf",
        "call_type": "voip",
        "notification_type": "visitor",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "status": "initializing",
        "display_status": "Initializing",
        "panel_id": 11,
        "panel_name": "Paul \"Muad'Dib\" \"Usul\" Atreides 31",
        "panel_sip": "panel_11",
        "provider": "internal"
      }
    }
  ]
}

GET  /v3/me/calls/DOES_NOT_EXIST/status

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "title": "Record not found",
      "detail": "Requested record could not be found"
    }
  ]
}

Call Status
GET/v3/me/calls/{call_guid}/status

URI Parameters
HideShow
call_guid
string (required) Example: 9326b0c1-b407-4fdf-b707-58ab5a6199bf

Calls

Sortable fields:

  • created_at

  • logged_at

  • notification_type

  • call_type

Filterable fields:

  • unit -> integer

  • notification_type -> enum(string)

  • call_type -> enum(string)

  • guid -> string

Enumerations:

  • call_type:

    • voip
    • mobile

  • notification_type:

    • visitor
    • delivery
GET /v3/me/calls
Requestsreturns a list of calls

GET  /v3/me/calls

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "5",
      "type": "calls",
      "attributes": {
        "guid": "fb4da1e2-6032-4a38-aa19-22b9cee8cb56",
        "call_type": "voip",
        "notification_type": "visitor",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "status": "initializing",
        "display_status": "Initializing",
        "initial": true,
        "provider": "internal"
      },
      "relationships": {
        "rollover_calls": {
          "data": []
        },
        "panel": {
          "data": {
            "id": "13",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "4",
      "type": "calls",
      "attributes": {
        "guid": "fe79cc11-1b00-48af-88eb-7f64bedfc8bc",
        "call_type": "voip",
        "notification_type": "visitor",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "status": "initializing",
        "display_status": "Initializing",
        "initial": true,
        "provider": "internal"
      },
      "relationships": {
        "rollover_calls": {
          "data": []
        },
        "panel": {
          "data": {
            "id": "13",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "3",
      "type": "calls",
      "attributes": {
        "guid": "b0c96ee5-a1a2-4a03-a4a4-06858661ea75",
        "call_type": "voip",
        "notification_type": "visitor",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "status": "initializing",
        "display_status": "Initializing",
        "initial": true,
        "provider": "internal"
      },
      "relationships": {
        "rollover_calls": {
          "data": []
        },
        "panel": {
          "data": {
            "id": "13",
            "type": "panels"
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/me/calls?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/me/calls?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/me/calls?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Calls
GET/v3/me/calls

Door Releases

Sortable fields:

  • created_at

  • logged_at

  • notification_type

  • call_type

Filterable fields:

  • unit -> integer

  • release_method -> enum

  • door_release_type -> enum

  • name -> string

  • call_guid -> string

Enumerations:

  • release_method:

    • mobile
    • panel
    • qr_key
    • nfc
    • voip
    • bluetooth
    • front_door_view
    • rfid

  • door_release_type:

    • visitor
    • delivery
GET /v3/me/door_releases
Requestsreturns a list of door releases

GET  /v3/me/door_releases

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "6",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "call_guid": "9d9a5302-db13-4a2a-a7eb-669b4598766c",
        "name": "Giovanni Okuneva",
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb/small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium/small_picture.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "81",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "24",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "14",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "17",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "5",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "call_guid": "1f0d2a69-3a02-48e2-a1ce-a0f0a4b3aaa3",
        "name": "Remona Kub",
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb/small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium/small_picture.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "81",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "24",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "14",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "16",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "4",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "call_guid": "b1a3086e-d2b0-42d6-b966-4c343d62b198",
        "name": "Rosita Kessler",
        "thumb_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/thumb/small_picture.jpg",
        "medium_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium/small_picture.jpg",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "81",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "24",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "14",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "15",
            "type": "panels"
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/me/door_releases?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/me/door_releases?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/me/door_releases?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Door Releases
GET/v3/me/door_releases

Messages

Sortable fields:

  • message_type

  • created_at

Filterable fields:

  • message_type -> enum

Enumerations:

  • message_type:
    • text
    • voice
GET /v3/me/messages
Requestsreturns a list of messages

GET  /v3/me/messages

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "3",
      "type": "messages",
      "attributes": {
        "message": null,
        "voice": {
          "url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/voice_message.mp3"
        },
        "message_type": "voice"
      }
    },
    {
      "id": "2",
      "type": "messages",
      "attributes": {
        "message": null,
        "voice": {
          "url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/voice_message.mp3"
        },
        "message_type": "voice"
      }
    },
    {
      "id": "1",
      "type": "messages",
      "attributes": {
        "message": null,
        "voice": {
          "url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/voice_message.mp3"
        },
        "message_type": "voice"
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/me/messages?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/me/messages?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/me/messages?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Messages
GET/v3/me/messages

Open Door

POST /v3/me/open_door
Requestssends a request to open the doorsends a request to open the door connected to a keypadreturns bad request

POST  /v3/me/open_door

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {},
    "type": "open_door",
    "relationships": {
      "panel": {
        "data": {
          "type": "panel",
          "id": 18
        }
      },
      "unit": {
        "data": {
          "type": "unit",
          "id": 91
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1",
    "type": "door_release_requests",
    "attributes": {
      "guid": "9115ea97-c4e3-4f33-a66e-a772322cac36",
      "created_at": "2022-07-26T09:34:52Z"
    }
  }
}

POST  /v3/me/open_door

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {},
    "type": "open_door",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 93
        }
      },
      "device": {
        "data": {
          "type": "keypads",
          "id": 1
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2",
    "type": "door_release_requests",
    "attributes": {
      "guid": "14bcc586-b5b9-474d-9af0-a48984d5ed6b",
      "created_at": "2022-07-26T09:34:52Z"
    }
  }
}

POST  /v3/me/open_door

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {},
    "type": "open_doors",
    "relationships": {
      "panels": {
        "data": {
          "type": "panels",
          "id": "DOES_NOT_EXIST"
        }
      },
      "unit": {
        "data": {
          "type": "unit",
          "id": 96
        }
      }
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/device"
      },
      "detail": "must exist"
    },
    {
      "source": {
        "pointer": "/data/attributes/building_open_door_button"
      },
      "detail": "Building open door feature has not been enabled"
    },
    {
      "source": {
        "pointer": "/data/attributes/release_method"
      },
      "detail": "disabled for this device"
    }
  ]
}

Open Door
POST/v3/me/open_door

Tokens

POST /v3/me/calls/twiliotest/token
Requestsreturns successgenerates_tokenreturns error

POST  /v3/me/calls/twiliotest/token

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "device_uuid": "test-123-test"
    },
    "type": "token",
    "relationships": null
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "tokens": {
    "twilio": "token-12345679-token"
  }
}

POST  /v3/me/calls/twiliotest/token

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "device_uuid": "test-123-test"
    },
    "type": "token",
    "relationships": null
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "tokens": {
    "twilio": "token-12345679-token"
  }
}

POST  /v3/me/calls/voiptest/token

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "device_uuid": "test-123-test"
    },
    "type": "token",
    "relationships": null
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "error": "Bad Request",
  "error_description": "Token was not generated"
}

Create
POST/v3/me/calls/{call_guid}/token

URI Parameters
HideShow
call_guid
string (required) Example: twiliotest

User

Resources that can be included:

  • tenants

Nested resources that can be included:

  • tenants.building

  • tenants.unit

  • tenants.panels

GET /v3/me
Requestsshows current user informationshows current user information with included resources

GET  /v3/me

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "32",
    "type": "users",
    "attributes": {
      "name": "Harlan Harber",
      "first_name": "Harlan",
      "last_name": "Harber",
      "contact_preference": "phone_call",
      "thumb_url": null,
      "medium_url": null,
      "sip_username": "32",
      "email": "lisa.kuvalis@rennerzieme.com",
      "sms_phone_number": null,
      "phone_number": null
    },
    "relationships": {
      "tenants": {
        "data": [
          {
            "id": "39",
            "type": "tenants"
          }
        ]
      }
    }
  }
}

GET  /v3/me?include=tenants.building,tenants.panels,tenants.unit

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "33",
    "type": "users",
    "attributes": {
      "name": "Versie Dare",
      "first_name": "Versie",
      "last_name": "Dare",
      "contact_preference": "phone_call",
      "thumb_url": null,
      "medium_url": null,
      "sip_username": "33",
      "email": "celine@sanford.com",
      "sms_phone_number": null,
      "phone_number": null
    },
    "relationships": {
      "tenants": {
        "data": [
          {
            "id": "40",
            "type": "tenants"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "40",
      "type": "tenants",
      "attributes": {
        "unit_id": 115,
        "inactive_at": null
      },
      "relationships": {
        "building": {
          "data": {
            "id": "90",
            "type": "buildings"
          }
        },
        "unit": {
          "data": {
            "id": "115",
            "type": "units"
          }
        },
        "panels": {
          "data": [
            {
              "id": "28",
              "type": "panels"
            }
          ]
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "90",
      "type": "buildings",
      "attributes": {
        "name": "Johnston, Metz and Mertz-109",
        "building_type": "multi_family",
        "mobile_logo_picture": {
          "thumb_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png",
          "medium_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png"
        },
        "panel_logo_picture": {
          "thumb_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png",
          "medium_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png"
        },
        "address_1": "620 Predovic Mills",
        "address_2": "Schneiderport, SC 24354-5956",
        "city": "Schneiderport",
        "state": "South Carolina",
        "zip_code": "24354-5956",
        "phone_number": "1-603-026-7570",
        "country": "us",
        "time_zone": "Etc/UTC",
        "open_door_button_enabled": true
      }
    },
    {
      "id": "115",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "00",
        "floor_number": 0
      }
    },
    {
      "id": "28",
      "type": "panels",
      "attributes": {
        "name": "Gaius Helen Mohiam 50",
        "nfc": {
          "uuid": "b0f65d93-ec0a-4852-a644-be321932c48e"
        }
      }
    }
  ]
}

Show
GET/v3/me

PUT /v3/me
Requestsupdates the current userreturns bad request

PUT  /v3/me

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tenants",
    "id": "34",
    "attributes": {
      "last_name": "Baker"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "34",
    "type": "users",
    "attributes": {
      "name": "Florencio Baker",
      "first_name": "Florencio",
      "last_name": "Baker",
      "contact_preference": "phone_call",
      "thumb_url": null,
      "medium_url": null,
      "sip_username": "34",
      "email": "magdalena@macejkovictorphy.co",
      "sms_phone_number": null,
      "phone_number": null
    },
    "relationships": {
      "tenants": {
        "data": [
          {
            "id": "41",
            "type": "tenants"
          }
        ]
      }
    }
  }
}

PUT  /v3/me

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tenants",
    "id": "35",
    "attributes": {
      "last_name": ""
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "error": "Bad Request",
  "error_description": "Last name can't be blank"
}

Update
PUT/v3/me

Devices

Devices

Fetch a list of devices that the authorized user has access to.

  • If a user is a tenant, only door devices that are installed, enabled and where he has access to are included.

  • If a user is an admin, a list of all devices from all buildings the user has access will be included.

Building id is included in relationships, and detailed building info can be requested with ?include=building parameter

GET /v3/devices
Requestsshows a list of devices with included resources

GET  /v3/devices?include=building

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": []
}

List
GET/v3/devices

Door Releases

Door Releases

Note: symbol ✓ marks permission on all entries in the authorized scope (e.g. all buildings where the Building Admin is authorized for administration* etc.)

List / Show Change Create Delete
Tenant ✓ - - -
Unit Admin ✓ - - -
Zone Admin ✓ - - -
Building Admin ✓ - - -

Request Samples with Filter:

GET /v3/door_releases?unit_id=11

GET /v3/door_releases?user_id=22

GET /v3/door_releases?unit_id=11&user_id=22

GET /v3/door_releases?door_release_type=delivery

Request Samples with Sort:

GET /v3/door_releases?sort=created

GET /v3/door_releases?sort=-created,name

The sort order for each attribute is ascending unless it is prefixed with a minus (U+002D HYPHEN-MINUS, “-“), in which case it is descending.

Allowed values for:

  • release_method:

    • mobile
    • panel
    • qr_key
    • nfc
    • voip

  • door_release_type:

    • visitor
    • delivery

  • panel_user_type:

    • default
    • doorman
GET /v3/door_releases
Requestsreturns recent door releases of the tenant's unit

GET  /v3/door_releases

Headers
Accept: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "32",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "doorman",
        "call_guid": "709ddff1-ba88-4084-a855-f895a5c818a1",
        "name": "Mari Schumm PhD",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "31",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "doorman",
        "call_guid": "2349ebab-0709-448c-8661-d4386f2a77c8",
        "name": "Jacquelyne Runolfsdottir MD",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "30",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "5c133730-1ea2-4078-a8b0-d75537a5364b",
        "name": "Leanna Zieme",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "29",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "ae55621f-ad37-42d8-a333-3e6196965a74",
        "name": "Dr. Joannie Reichel",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "28",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "delivery",
        "panel_user_type": "default",
        "call_guid": "46b6c8fb-9006-4aeb-a016-2aa7f3bd28aa",
        "name": "Ms. Ardith Grant",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "27",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "delivery",
        "panel_user_type": "default",
        "call_guid": "731b8944-36b2-4fa6-8936-3d648b7fae12",
        "name": "Tayna Towne Sr.",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "26",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "1da448fd-1f61-4146-b210-ea1ed02496d2",
        "name": "Hobert Kertzmann",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "25",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "ba99a295-c5b9-481b-b0bc-97dcd240be9c",
        "name": "Gregorio Frami",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "24",
      "type": "door_releases",
      "attributes": {
        "release_method": "qr_key",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "12b205a2-a710-4b3a-a139-78695d02d43b",
        "name": "Brittni Runolfsson",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "23",
      "type": "door_releases",
      "attributes": {
        "release_method": "qr_key",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "6fe90809-b98d-4e0c-8688-2f6b382d7211",
        "name": "Miss Hue Yundt",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "22",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "c0c02b46-4cca-47f5-8484-3b5ff7b52761",
        "name": "Damion Paucek DVM",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "21",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "f3b563b6-bc9a-41b2-9266-cb3fe3679f9c",
        "name": "Dane Schneider",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        },
        "device": {
          "data": {
            "id": "41",
            "type": "panels"
          }
        }
      }
    },
    {
      "id": "20",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "11a525b3-cae4-4859-9697-450fbf698a44",
        "name": "Flo Tromp",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": null
        },
        "device": {
          "data": {
            "id": "3",
            "type": "keypads"
          }
        }
      }
    },
    {
      "id": "19",
      "type": "door_releases",
      "attributes": {
        "release_method": "mobile",
        "door_release_type": "visitor",
        "panel_user_type": "default",
        "call_guid": "9f9e5366-e713-418a-aa26-170559636e65",
        "name": "Jong Fadel",
        "created_at": "2022-07-26T09:31:50Z",
        "logged_at": "2022-07-26T09:31:50Z",
        "thumb_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg",
        "medium_url": "/assets/no_pic-8244a33d73b6a6668863761ddfbf8baa65f32869c273f8eba97bb8478c9a1d39.jpg"
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "263",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "48",
            "type": "users"
          }
        },
        "panel": {
          "data": null
        },
        "device": {
          "data": {
            "id": "3",
            "type": "keypads"
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/door_releases?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/door_releases?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/door_releases?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

List
GET/v3/door_releases

Keychains

Keychains

How to Create a Keychain with Virtual Keys

We use two concepts when creating a virtual key:

  • Keychain

  • Virtual Key

Keychain

Keychain contains information about the kind of key, what its duration is etc. A keychain can have many virtual keys, so a single keychain can be used to create virtual keys for multiple people. Information from the keychain is used by the panels to verify if the virtual key is still valid. Keychains must be associated with a unit.

Parameters that are always required for all keychains:

name -> string

tenant -> relationship or unit -> relationship

If you wish to have the keychain associated with tenant send the tenant relationship, otherwise send the unit as relationship. The second case is useful if you have large tenant turnover in a unit (e.g short term tourist renals). If you wish to allow your tenants to create and share keys by themselves, tenant association is required.

Custom keychains

Custom keychains have a start and end date when they are valid e.g. a virtual key for a custom keychain will be valid from 01/01/2019 11:50 to 03/03/2019 13:45. Always use the iso8601 format when sending datetime data.

Endpoint examples

Parameters that are required for custom keychains:

starts_at -> datetime (iso8601)

ends_at -> datetime (iso8601)

Recurring keychains

Recurring keychains are valid only on certain weekdays and inside certain time periods e.g. a virtual key for a recurring keychain will be valid only on wednesdays and thursdays between 12:30 and 16:30. Recurring keychains also use the start and end dates to determine when they will completely expired, so if a recurring keychain has an end date on 03/03/2019 the above virtual key will no longer be valid on wendesdays and thursdays. Always use the iso8601 format when sending datetime data, for time data use the hh:mm format (06:21, 11:53, 22:51).

Endpoint examples

Parameters that are required for custom keychains:

weekdays -> array(enum)

start_date -> date (iso8601)

end_date -> date (iso8601)

time_to -> time (hh:mm)

time_from -> time (hh:mm)

Enumerations:

  • weekdays:
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat
    • sun

One time keychains

Virtual keys that belong to one time keychains can be used only once inside a predefined period of tim, which is determined by starts_at and ends_at fields. After they are used or if they’re not inside a predefined period of time they are no longer valid e.g. if a keychain’s validity period is from 01/01/2019 11:50 to 03/03/2019 13:45, it will not be valid if it’s used inside that period or when the time of 03/03/2019 13:45 has passed.

To determine if a particular virtual key for the one time keychain, or delivery pass has been used, check the used_at, one_time_key_used_at field on the virtual key.

Parameters that are required for one time keychains:

starts_at -> datetime (iso8601)

ends_at -> datetime (iso8601)

Virtual Key

Virtual key is used by a single person to open a door, it contains either an e-mail or an sms number of the person who will use it, a url to the qr code of the key which can be scanned to gain access to the building and a name which is used when the key is sent to the user.

Virtual keys are created from an array of recipients (e-mail or a mobile phone number) that is added to keychain parameters or on a separate endpoint.

Parameters that are required to create virtual keys:

recipients -> array(string)

Filterable fields:

  • unit -> integer

  • tenant -> integer

POST /v3/keychains/custom
Requestscreates a new keychain with associated qr keyscreates a keychain, virtual keys for one KeyLocker Compartmentcreates a keychain and virtual keys for a random free KeyLocker Compartmentcreates a keychain and virtual keys for the KeyLocker Compartmentcreates a keychain and virtual keys for the KeyLocker Compartmentcreates a keycahin and virtual keys for the KeyLocker Compartmentcreates a new keychain with associated qr keysreturns bad request

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:03+00:00",
      "ends_at": "2022-07-28T09:34:58+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 139
        }
      },
      "devices": {
        "data": [
          {
            "type": "keypads",
            "id": 2
          }
        ]
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "15",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:03Z",
      "ends_at": "2022-07-28T09:34:58Z",
      "time_from": "09:35",
      "time_to": "09:34",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "7",
            "type": "virtual_keys"
          },
          {
            "id": "8",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": [
          {
            "id": "2",
            "type": "keypads"
          },
          {
            "id": "2",
            "type": "keypads"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "7",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-3ir9am.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "894411",
        "instructions_url": "http://user.butterflymx.test/public/pfeffer-beatty-and-wehner-133/virtual_keys/7/2a632232b3129b36e6803a444ce65036",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "8",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1g7oe9f.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "200571",
        "instructions_url": "http://user.butterflymx.test/public/pfeffer-beatty-and-wehner-133/virtual_keys/8/8c03323ad4686e3532f07e9a6cb38eb5",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "2",
      "type": "keypads",
      "attributes": {
        "name": "Hwi Noree 62"
      },
      "relationships": {
        "building": {
          "data": {
            "id": "114",
            "type": "buildings"
          }
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:05+00:00",
      "ends_at": "2022-07-28T09:35:00+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ],
      "key_locker": {
        "id": 2,
        "compartment": "I1"
      }
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 141
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "16",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:05Z",
      "ends_at": "2022-07-28T09:35:00Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "9",
            "type": "virtual_keys"
          },
          {
            "id": "10",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "9",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-3we2cf.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "402883",
        "instructions_url": "http://user.butterflymx.test/public/walker-llc-135/virtual_keys/9/1cc24090ddec43d260a7be05c83629d5",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "10",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1ke7zho.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "047896",
        "instructions_url": "http://user.butterflymx.test/public/walker-llc-135/virtual_keys/10/5a2164890c371019725ff2ac18583170",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:08+00:00",
      "ends_at": "2022-07-28T09:35:03+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ],
      "key_locker": {
        "id": 3,
        "compartment": "any_when_used"
      }
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 163
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "17",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:08Z",
      "ends_at": "2022-07-28T09:35:03Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "11",
            "type": "virtual_keys"
          },
          {
            "id": "12",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "11",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-izwei1.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "215048",
        "instructions_url": "http://user.butterflymx.test/public/gleason-group-176/virtual_keys/11/04680ec033f07a16874db8f8c7460459",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "12",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-6gp0jf.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "440712",
        "instructions_url": "http://user.butterflymx.test/public/gleason-group-176/virtual_keys/12/32151458abfcf0adb6ce6a4b55f17b03",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:10+00:00",
      "ends_at": "2022-07-28T09:35:05+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ],
      "key_locker": {
        "id": 4,
        "compartment_id": 68
      }
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 185
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "18",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:10Z",
      "ends_at": "2022-07-28T09:35:05Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "13",
            "type": "virtual_keys"
          },
          {
            "id": "14",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "13",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-kbbrsy.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "386556",
        "instructions_url": "http://user.butterflymx.test/public/larson-murazik-217/virtual_keys/13/7fe9f060f3274a439be56d7a9bc007a2",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "14",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-c01qt2.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "113007",
        "instructions_url": "http://user.butterflymx.test/public/larson-murazik-217/virtual_keys/14/dffd3d47389955991b48c56a9f7914de",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:12+00:00",
      "ends_at": "2022-07-28T09:35:07+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ],
      "key_locker": {
        "id": 5,
        "compartment_id": 89,
        "item_return_policy": "return"
      }
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 207
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "19",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:12Z",
      "ends_at": "2022-07-28T09:35:07Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "15",
            "type": "virtual_keys"
          },
          {
            "id": "16",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "15",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-i408xs.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "870101",
        "instructions_url": "http://user.butterflymx.test/public/ankunding-yost-258/virtual_keys/15/f74b5e2fdde4b20bf2f38b4bd9b5744c",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "16",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1acp6ax.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "916530",
        "instructions_url": "http://user.butterflymx.test/public/ankunding-yost-258/virtual_keys/16/b6fcd737074dfde5457f44852fa3d032",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:15+00:00",
      "ends_at": "2022-07-28T09:35:10+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ],
      "key_locker": {
        "id": 6,
        "compartment_id": 103
      },
      "item_return_policy": "return"
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 229
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "20",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:15Z",
      "ends_at": "2022-07-28T09:35:10Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "17",
            "type": "virtual_keys"
          },
          {
            "id": "18",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "17",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1nqb092.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "881348",
        "instructions_url": "http://user.butterflymx.test/public/hills-kirlin-and-wolff-299/virtual_keys/17/bc968522908902fd59c04d4f5682d922",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "18",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-batf4.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "130164",
        "instructions_url": "http://user.butterflymx.test/public/hills-kirlin-and-wolff-299/virtual_keys/18/212b28926252f2c9b5dcb006e202da3c",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "2022-07-26T09:35:15+00:00",
      "ends_at": "2022-07-28T09:35:10+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": 49
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "21",
    "type": "keychains",
    "attributes": {
      "name": "Custom Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:15Z",
      "ends_at": "2022-07-28T09:35:10Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "19",
            "type": "virtual_keys"
          },
          {
            "id": "20",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "19",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-no2hdf.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "949879",
        "instructions_url": "http://user.butterflymx.test/public/howell-torp-and-bergnaum-340/virtual_keys/19/6e5c29189f08b371981e29a12237fdd2",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "20",
      "type": "virtual_keys",
      "attributes": {
        "name": "Custom Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-14klq6a.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "640220",
        "instructions_url": "http://user.butterflymx.test/public/howell-torp-and-bergnaum-340/virtual_keys/20/177bac997a8109e7975d5006601a58f6",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/custom

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Custom Key",
      "starts_at": "",
      "ends_at": "2022-07-28T09:35:11+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": 50
        }
      }
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/starts_at"
      },
      "detail": "can't be blank"
    },
    {
      "source": {
        "pointer": "/data/attributes/starts_at"
      },
      "detail": "is not a valid datetime"
    },
    {
      "source": {
        "pointer": "/data/attributes/ends_at"
      },
      "detail": "Error occurred validating ends_at for :after restriction:\ncomparison of ActiveSupport::TimeWithZone with nil failed"
    }
  ]
}

Create Custom Keychain
POST/v3/keychains/custom

GET /v3/keychains
Requestsshows a list of keychainsshows a list of keychains with included resources

GET  /v3/keychains

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "27",
      "type": "keychains",
      "attributes": {
        "name": "Education Manager 19",
        "weekdays": [],
        "starts_at": "2022-07-26T09:35:16Z",
        "ends_at": "2022-07-26T10:35:16Z",
        "time_from": "09:35",
        "time_to": "10:35",
        "kind": "custom",
        "start_date": "2022-07-26",
        "end_date": "2022-07-26",
        "allow_unit_access": false
      },
      "relationships": {
        "virtual_keys": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "26",
      "type": "keychains",
      "attributes": {
        "name": "Marketing Manager 18",
        "weekdays": [],
        "starts_at": "2022-07-26T09:35:16Z",
        "ends_at": "2022-07-26T10:35:16Z",
        "time_from": "09:35",
        "time_to": "10:35",
        "kind": "custom",
        "start_date": "2022-07-26",
        "end_date": "2022-07-26",
        "allow_unit_access": false
      },
      "relationships": {
        "virtual_keys": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "25",
      "type": "keychains",
      "attributes": {
        "name": "Design Agent 17",
        "weekdays": [],
        "starts_at": "2022-07-26T09:35:16Z",
        "ends_at": "2022-07-26T10:35:16Z",
        "time_from": "09:35",
        "time_to": "10:35",
        "kind": "custom",
        "start_date": "2022-07-26",
        "end_date": "2022-07-26",
        "allow_unit_access": false
      },
      "relationships": {
        "virtual_keys": {
          "data": [
            {
              "id": "23",
              "type": "virtual_keys"
            }
          ]
        },
        "devices": {
          "data": []
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/keychains?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/keychains?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/keychains?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

GET  /v3/keychains?include=virtual_keys,devices

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "30",
      "type": "keychains",
      "attributes": {
        "name": "District Hospitality Administrator 22",
        "weekdays": [],
        "starts_at": "2022-07-26T09:35:17Z",
        "ends_at": "2022-07-26T10:35:17Z",
        "time_from": "09:35",
        "time_to": "10:35",
        "kind": "custom",
        "start_date": "2022-07-26",
        "end_date": "2022-07-26",
        "allow_unit_access": false
      },
      "relationships": {
        "virtual_keys": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "29",
      "type": "keychains",
      "attributes": {
        "name": "Forward Director 21",
        "weekdays": [],
        "starts_at": "2022-07-26T09:35:17Z",
        "ends_at": "2022-07-26T10:35:17Z",
        "time_from": "09:35",
        "time_to": "10:35",
        "kind": "custom",
        "start_date": "2022-07-26",
        "end_date": "2022-07-26",
        "allow_unit_access": false
      },
      "relationships": {
        "virtual_keys": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "28",
      "type": "keychains",
      "attributes": {
        "name": "Marketing Assistant 20",
        "weekdays": [],
        "starts_at": "2022-07-26T09:35:17Z",
        "ends_at": "2022-07-26T10:35:17Z",
        "time_from": "09:35",
        "time_to": "10:35",
        "kind": "custom",
        "start_date": "2022-07-26",
        "end_date": "2022-07-26",
        "allow_unit_access": false
      },
      "relationships": {
        "virtual_keys": {
          "data": [
            {
              "id": "24",
              "type": "virtual_keys"
            }
          ]
        },
        "devices": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "24",
      "type": "virtual_keys",
      "attributes": {
        "name": "Tyson Ernser",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-17dswzy.png",
        "email": "berenice_prosacco@example.net",
        "sms_number": "+12546259330",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "743083",
        "instructions_url": "http://user.butterflymx.test/public/effertz-inc-362/virtual_keys/24/0b58962274e9a8b72977e51b9137b89f",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/keychains?include=virtual_keys%2Cdevices&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/keychains?include=virtual_keys%2Cdevices&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/keychains?include=virtual_keys%2Cdevices&page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

List
GET/v3/keychains

GET /v3/keychains/31
Requestsreturns the keychain

GET  /v3/keychains/31

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "31",
    "type": "keychains",
    "attributes": {
      "name": "Healthcare Developer 23",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:17Z",
      "ends_at": "2022-07-26T10:35:17Z",
      "time_from": "09:35",
      "time_to": "10:35",
      "kind": "custom",
      "start_date": "2022-07-26",
      "end_date": "2022-07-26",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "25",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  }
}

Show
GET/v3/keychains/{id}

URI Parameters
HideShow
id
number (required) Example: 31
DELETE /v3/keychains/32
Requestsdeletes the keychain and associated qr keys

DELETE  /v3/keychains/32

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Delete
DELETE/v3/keychains/{id}

URI Parameters
HideShow
id
number (required) Example: 32
POST /v3/keychains/one_time
Requestscreates a new keychain with associated qr keyscreates a new keychain with associated qr keysreturns bad request

POST  /v3/keychains/one_time

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "One-Time Key",
      "starts_at": "2022-07-26T09:35:26+00:00",
      "ends_at": "2022-07-28T09:35:21+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 308
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "33",
    "type": "keychains",
    "attributes": {
      "name": "One-Time Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:26Z",
      "ends_at": "2022-07-28T09:35:21Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "one_time",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "27",
            "type": "virtual_keys"
          },
          {
            "id": "28",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "27",
      "type": "virtual_keys",
      "attributes": {
        "name": "One-Time Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-pqaxk6.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "736745",
        "instructions_url": "http://user.butterflymx.test/public/oberbrunner-and-sons-385/virtual_keys/27/f97ce813ca3b1c7e2aa8cedc0f571241",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "28",
      "type": "virtual_keys",
      "attributes": {
        "name": "One-Time Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1uq8es1.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "218988",
        "instructions_url": "http://user.butterflymx.test/public/oberbrunner-and-sons-385/virtual_keys/28/19224a810701233977ade659565536ac",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/one_time

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "One-Time Key",
      "starts_at": "2022-07-26T09:35:27+00:00",
      "ends_at": "2022-07-28T09:35:22+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": 2278
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "34",
    "type": "keychains",
    "attributes": {
      "name": "One-Time Key",
      "weekdays": [],
      "starts_at": "2022-07-26T09:35:27Z",
      "ends_at": "2022-07-28T09:35:22Z",
      "time_from": "09:35",
      "time_to": "09:35",
      "kind": "one_time",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "29",
            "type": "virtual_keys"
          },
          {
            "id": "30",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "29",
      "type": "virtual_keys",
      "attributes": {
        "name": "One-Time Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-17vdmad.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "448650",
        "instructions_url": "http://user.butterflymx.test/public/jerde-paucek-386/virtual_keys/29/496a0e32dea3b03ea358028d064fa507",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "30",
      "type": "virtual_keys",
      "attributes": {
        "name": "One-Time Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1n55796.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "198499",
        "instructions_url": "http://user.butterflymx.test/public/jerde-paucek-386/virtual_keys/30/e6d14b599717b7f4238235cdaa881602",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/one_time

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "One-Time Key",
      "starts_at": "",
      "ends_at": "2022-07-28T09:35:23+00:00",
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": 2279
        }
      }
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/starts_at"
      },
      "detail": "can't be blank"
    },
    {
      "source": {
        "pointer": "/data/attributes/starts_at"
      },
      "detail": "is not a valid datetime"
    },
    {
      "source": {
        "pointer": "/data/attributes/ends_at"
      },
      "detail": "Error occurred validating ends_at for :after restriction:\ncomparison of ActiveSupport::TimeWithZone with nil failed"
    }
  ]
}

Create One-Time Keychain
POST/v3/keychains/one_time

POST /v3/keychains/recurring
Requestscreates a new keychain with associated qr keyscreates a new keychain with associated qr keyscreates a new keychain with associated devicesreturns bad request

POST  /v3/keychains/recurring

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Recurring Key",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "time_from": "11:20",
      "time_to": "11:50",
      "weekdays": [
        "wed",
        "sat"
      ],
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "unit": {
        "data": {
          "type": "unit",
          "id": 327
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "39",
    "type": "keychains",
    "attributes": {
      "name": "Recurring Key",
      "weekdays": [
        "wed",
        "sat"
      ],
      "starts_at": "2022-07-26T11:20:00Z",
      "ends_at": "2022-07-28T11:50:00Z",
      "time_from": "11:20",
      "time_to": "11:50",
      "kind": "recurring",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "33",
            "type": "virtual_keys"
          },
          {
            "id": "34",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "33",
      "type": "virtual_keys",
      "attributes": {
        "name": "Recurring Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1eca4ys.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "633215",
        "instructions_url": "http://user.butterflymx.test/public/gerhold-glover-and-wuckert-400/virtual_keys/33/f88d7a017afd97833b58dca5537282c1",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "34",
      "type": "virtual_keys",
      "attributes": {
        "name": "Recurring Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-zgst7q.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "090662",
        "instructions_url": "http://user.butterflymx.test/public/gerhold-glover-and-wuckert-400/virtual_keys/34/c8bc5e53859956528e05bea99805f732",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/recurring

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Recurring Key",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "time_from": "11:20",
      "time_to": "11:50",
      "weekdays": [
        "wed",
        "sat"
      ],
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": 2289
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "40",
    "type": "keychains",
    "attributes": {
      "name": "Recurring Key",
      "weekdays": [
        "wed",
        "sat"
      ],
      "starts_at": "2022-07-26T11:20:00Z",
      "ends_at": "2022-07-28T11:50:00Z",
      "time_from": "11:20",
      "time_to": "11:50",
      "kind": "recurring",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "35",
            "type": "virtual_keys"
          },
          {
            "id": "36",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "35",
      "type": "virtual_keys",
      "attributes": {
        "name": "Recurring Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-10wnr91.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "792113",
        "instructions_url": "http://user.butterflymx.test/public/marquardt-and-sons-401/virtual_keys/35/e452610f3434d25869348b438bc22cfb",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "36",
      "type": "virtual_keys",
      "attributes": {
        "name": "Recurring Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-hxxwgf.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "476345",
        "instructions_url": "http://user.butterflymx.test/public/marquardt-and-sons-401/virtual_keys/36/9aa831fef99554427841d642a280a46a",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    }
  ]
}

POST  /v3/keychains/recurring

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "keychains",
    "attributes": {
      "name": "Recurring Key",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "time_from": "11:20",
      "time_to": "11:50",
      "weekdays": [
        "wed",
        "sat"
      ],
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "relationships": {
      "devices": {
        "data": [
          {
            "id": "52",
            "type": "panels"
          },
          {
            "id": "53",
            "type": "panels"
          }
        ]
      },
      "tenant": {
        "data": {
          "id": "2290",
          "type": "tenant"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "41",
    "type": "keychains",
    "attributes": {
      "name": "Recurring Key",
      "weekdays": [
        "wed",
        "sat"
      ],
      "starts_at": "2022-07-26T11:20:00Z",
      "ends_at": "2022-07-28T11:50:00Z",
      "time_from": "11:20",
      "time_to": "11:50",
      "kind": "recurring",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "allow_unit_access": false
    },
    "relationships": {
      "virtual_keys": {
        "data": [
          {
            "id": "37",
            "type": "virtual_keys"
          },
          {
            "id": "38",
            "type": "virtual_keys"
          }
        ]
      },
      "devices": {
        "data": [
          {
            "id": "52",
            "type": "panels"
          },
          {
            "id": "53",
            "type": "panels"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "37",
      "type": "virtual_keys",
      "attributes": {
        "name": "Recurring Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-6oez5g.png",
        "email": "test@example.com",
        "sms_number": null,
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "166096",
        "instructions_url": "http://user.butterflymx.test/public/king-lesch-402/virtual_keys/37/a21898c046adc1f819b879ac4dbd9e14",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "38",
      "type": "virtual_keys",
      "attributes": {
        "name": "Recurring Key",
        "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1frs4lu.png",
        "email": null,
        "sms_number": "+12345678901",
        "used_at": null,
        "one_time_key_used_at": null,
        "pin": "242996",
        "instructions_url": "http://user.butterflymx.test/public/king-lesch-402/virtual_keys/38/89a51f6bfc0b003148532844e079f60c",
        "sent_at": null,
        "synced_with_remote_lock": false
      },
      "relationships": {
        "door_releases": {
          "data": []
        }
      }
    },
    {
      "id": "52",
      "type": "panels",
      "attributes": {
        "name": "Ilban Richese 177",
        "nfc": {
          "uuid": "224def7a-9c99-4b6c-b989-1e453c8da46d"
        }
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1379",
            "type": "buildings"
          }
        }
      }
    },
    {
      "id": "53",
      "type": "panels",
      "attributes": {
        "name": "Liet-Kynes 178",
        "nfc": {
          "uuid": "92a83bb5-bb44-4713-b38e-22ca11ef6294"
        }
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1379",
            "type": "buildings"
          }
        }
      }
    }
  ]
}

POST  /v3/keychains/recurring

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "",
      "start_date": "2022-07-26",
      "end_date": "2022-07-28",
      "time_from": "11:20",
      "time_to": "11:50",
      "weekdays": [
        "wed",
        "sat"
      ],
      "recipients": [
        "test@example.com",
        "+12345678901"
      ]
    },
    "type": "keychains",
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": 2291
        }
      }
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "can't be blank"
    }
  ]
}

Create Recurring Keychain
POST/v3/keychains/recurring

Virtual Keys

POST /v3/keychains/35/virtual_keys
Requestscreates a new qr keyreturns bad requestreturns not found

POST  /v3/keychains/35/virtual_keys

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Virtual Key",
      "email": "test@example.com"
    },
    "type": "virtual_keys",
    "relationships": null
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "31",
    "type": "virtual_keys",
    "attributes": {
      "name": "Virtual Key",
      "qr_code_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/original/qr_code_20220726-782-1vvn2ta.png",
      "email": "test@example.com",
      "sms_number": null,
      "used_at": null,
      "one_time_key_used_at": null,
      "pin": "547799",
      "instructions_url": "http://user.butterflymx.test/public/parisian-koch-and-pouros-396/virtual_keys/31/8fd7c7998a33adb38fb4d3ab783010d4",
      "sent_at": null,
      "synced_with_remote_lock": false
    },
    "relationships": {
      "door_releases": {
        "data": []
      }
    }
  }
}

POST  /v3/keychains/36/virtual_keys

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Virtual Key",
      "sms_number": "DOES_NOT_EXIST"
    },
    "type": "virtual_keys",
    "relationships": null
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/sms_number"
      },
      "detail": "DOES_NOT_EXIST is invalid"
    }
  ]
}

POST  /v3/keychains/DOES_NOT_EXIST/virtual_keys

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Virtual Key",
      "email": "test@example.com"
    },
    "type": "virtual_keys",
    "relationships": null
  }
}
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "title": "Record not found",
      "detail": "Requested record could not be found"
    }
  ]
}

Create
POST/v3/keychains/{keychain_id}/virtual_keys

URI Parameters
HideShow
keychain_id
number (required) Example: 35
DELETE /v3/keychains/38/virtual_keys/32
Requestsdeletes the virtual key

DELETE  /v3/keychains/38/virtual_keys/32

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Delete
DELETE/v3/keychains/{keychain_id}/virtual_keys/{id}

URI Parameters
HideShow
keychain_id
number (required) Example: 38
id
number (required) Example: 32

Notifications

Call Accepted

POST /v3/notifications/call_accepted
Requestsreturns notification successreturns validation error

POST  /v3/notifications/call_accepted

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "42",
    "attributes": {
      "panel_id": 42,
      "video": true,
      "audio": false,
      "call_guid": "6f1fe536-a3b0-40cf-a65b-357979f3db3a"
    }
  }
}
Responses204
This response has no content.

POST  /v3/notifications/call_accepted

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "43",
    "attributes": {
      "panel_id": "NOT_EXIST",
      "video": true,
      "audio": false,
      "call_guid": "78222404-9132-4979-9ddc-af874daf08c1"
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/panel_id"
      },
      "detail": "No panel with that ID"
    }
  ]
}

Call Accepted
POST/v3/notifications/call_accepted

Call Ended

POST /v3/notifications/call_ended
Requestsreturns notification successreturns validation error

POST  /v3/notifications/call_ended

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "44",
    "attributes": {
      "panel_id": 44,
      "call_guid": "a8e860c6-9755-44ee-ae51-d9f94f3cbea8"
    }
  }
}
Responses204
This response has no content.

POST  /v3/notifications/call_ended

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "45",
    "attributes": {
      "panel_id": "NOT_EXIST",
      "call_guid": "39c4d1d7-828f-4530-94d8-14d868b8576d"
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/panel_id"
      },
      "detail": "No panel with that ID"
    }
  ]
}

Call Ended
POST/v3/notifications/call_ended

Is Active

POST /v3/notifications/is_active
Requestsreturns notification successreturns validation error

POST  /v3/notifications/is_active

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "46",
    "attributes": {
      "panel_id": 46,
      "call_guid": "51a07999-7557-4ead-9da4-4b835e86cf96"
    }
  }
}
Responses204
This response has no content.

POST  /v3/notifications/is_active

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "47",
    "attributes": {
      "panel_id": "NOT_EXIST",
      "call_guid": "cbd4106e-45b4-4ac0-a375-878ed63bafc4"
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/panel_id"
      },
      "detail": "No panel with that ID"
    }
  ]
}

Is Active
POST/v3/notifications/is_active

Open Door

POST /v3/notifications/open_door
Requestsreturns notification successreturns validation error

POST  /v3/notifications/open_door

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "48",
    "attributes": {
      "panel_id": 48,
      "call_guid": "d6b8c279-ce06-4c61-a14f-0b318781369e"
    }
  }
}
Responses204
This response has no content.

POST  /v3/notifications/open_door

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "49",
    "attributes": {
      "panel_id": "NOT_EXIST",
      "call_guid": "a22f3786-7c0e-4670-bf06-ba70f21f7035"
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/panel_id"
      },
      "detail": "No panel with that ID"
    }
  ]
}

Open Door
POST/v3/notifications/open_door

Toggle Camera

POST /v3/notifications/toggle_camera
Requestsreturns notification successreturns validation error

POST  /v3/notifications/toggle_camera

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "50",
    "attributes": {
      "panel_id": 50,
      "video": true,
      "audio": false,
      "call_guid": "6f76d524-1995-493e-ae7b-438f93b1ae21"
    }
  }
}
Responses204
This response has no content.

POST  /v3/notifications/toggle_camera

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "notifications",
    "id": "51",
    "attributes": {
      "panel_id": "NOT_EXIST",
      "video": true,
      "audio": false,
      "call_guid": "6bc975af-db0a-45a7-be9a-90d3b1592374"
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/panel_id"
      },
      "detail": "No panel with that ID"
    }
  ]
}

Toggle Camera
POST/v3/notifications/toggle_camera

Pins

Pins

On these endpoints you can create and view PINs for tenants. The id parameter in the request must be the id of the tenant.

Parameters that are required for pins:

id -> integer

code -> string (must be numeric)

POST /v3/pins/combine
Requestsreturns success

POST  /v3/pins/combine

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pins",
    "id": "2280",
    "attributes": {}
  }
}
Responses204
This response has no content.

Combine
POST/v3/pins/combine

GET /v3/pins/2281
Requestsreturns the PIN code

GET  /v3/pins/2281

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2281",
    "type": "pins",
    "attributes": {
      "code": "5834",
      "unique_code": null
    }
  }
}

Show
GET/v3/pins/{id}

URI Parameters
HideShow
id
number (required) Example: 2281
PUT /v3/pins
Requestschanges the pin for the tenantdoes not change the pin for the tenant

PUT  /v3/pins

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pins",
    "id": "2282",
    "attributes": {
      "code": "0854",
      "unique_code": "085436"
    }
  }
}
Responses204
This response has no content.

PUT  /v3/pins

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pins",
    "id": "2283",
    "attributes": {
      "code": ""
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/code"
      },
      "detail": "can't be blank"
    },
    {
      "source": {
        "pointer": "/data/attributes/code"
      },
      "detail": "is not a number"
    },
    {
      "source": {
        "pointer": "/data/attributes/code"
      },
      "detail": "is the wrong length (should be 4 characters)"
    }
  ]
}

Set
PUT/v3/pins

Tenants

Integrations

Integrations

Allowed integrators:

  • webhook

Allowed config attributes for integrators:

  • webhook
    • url (String)
    • method (String get or post)

Allowed binding resource types:

  • call

  • door_release

GET /v3/tenants/2262/integrations
Requestsreturns the list of integrations associated with this tenant

GET  /v3/tenants/2262/integrations

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70",
      "type": "integrations",
      "attributes": {
        "integrator": "webhook",
        "config": {
          "method": "get",
          "url": "http://localhost:999"
        },
        "bindings": [
          {
            "resource_type": "door_release",
            "resource_id": "7",
            "actions": [
              "update",
              "destroy"
            ]
          }
        ]
      },
      "relationships": {
        "bindings": {
          "data": [
            {
              "resource_type": "door_release",
              "resource_id": "7",
              "actions": [
                "update",
                "destroy"
              ]
            }
          ]
        },
        "building": {
          "data": null
        },
        "tenant": {
          "data": {
            "id": "2262",
            "type": "units_users"
          }
        }
      },
      "links": {
        "self": "http://api.butterflymx.com/v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70"
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/tenants/2262/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "first": "http://api.butterflymx.com/v3/tenants/2262/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/tenants/2262/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

List
GET/v3/tenants/{tenant_id}/integrations

URI Parameters
HideShow
tenant_id
number (required) Example: 2262
GET /v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
Requestsreturns the requested integration

GET  /v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70",
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "config": {
        "method": "get",
        "url": "http://localhost:999"
      },
      "bindings": [
        {
          "resource_type": "door_release",
          "resource_id": "7",
          "actions": [
            "update",
            "destroy"
          ]
        }
      ]
    },
    "relationships": {
      "bindings": {
        "data": [
          {
            "resource_type": "door_release",
            "resource_id": "7",
            "actions": [
              "update",
              "destroy"
            ]
          }
        ]
      },
      "building": {
        "data": null
      },
      "tenant": {
        "data": {
          "id": "2262",
          "type": "units_users"
        }
      }
    },
    "links": {
      "self": "http://api.butterflymx.com/v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70"
    }
  }
}

Show
GET/v3/tenants/{tenant_id}/integrations/{id}

URI Parameters
HideShow
tenant_id
number (required) Example: 2262
id
string (required) Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
POST /v3/tenants/2262/integrations
Requestscreates the integration for the tenant

POST  /v3/tenants/2262/integrations

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Body
{
  "data": {
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "configuration": {
        "url": "http://localhost:666",
        "method": "post"
      },
      "bindings": [
        {
          "actions": [
            "create"
          ],
          "resource_type": "call",
          "resource_id": null
        }
      ]
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70",
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "config": {
        "method": "post",
        "url": "http://localhost:666"
      },
      "bindings": [
        {
          "resource_type": "call",
          "resource_id": null,
          "actions": [
            "create"
          ]
        }
      ]
    },
    "relationships": {
      "bindings": {
        "data": [
          {
            "resource_type": "call",
            "resource_id": null,
            "actions": [
              "create"
            ]
          }
        ]
      },
      "building": {
        "data": null
      },
      "tenant": {
        "data": {
          "id": "2262",
          "type": "units_users"
        }
      }
    },
    "links": {
      "self": "http://api.butterflymx.com/v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70"
    }
  }
}

Create
POST/v3/tenants/{tenant_id}/integrations

URI Parameters
HideShow
tenant_id
number (required) Example: 2262
PATCH /v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
Requestsupdates the tenet's integration

PATCH  /v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Body
{
  "data": {
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "configuration": {
        "url": "http://localhost:999",
        "method": "get"
      },
      "bindings": [
        {
          "actions": [
            "update",
            "destroy"
          ],
          "resource_type": "door_release",
          "resource_id": "7"
        }
      ]
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70",
    "type": "integrations",
    "attributes": {
      "integrator": "webhook",
      "config": {
        "method": "get",
        "url": "http://localhost:999"
      },
      "bindings": [
        {
          "resource_type": "door_release",
          "resource_id": "7",
          "actions": [
            "update",
            "destroy"
          ]
        }
      ]
    },
    "relationships": {
      "bindings": {
        "data": [
          {
            "resource_type": "door_release",
            "resource_id": "7",
            "actions": [
              "update",
              "destroy"
            ]
          }
        ]
      },
      "building": {
        "data": null
      },
      "tenant": {
        "data": {
          "id": "2262",
          "type": "units_users"
        }
      }
    },
    "links": {
      "self": "http://api.butterflymx.com/v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70"
    }
  }
}

Update
PATCH/v3/tenants/{tenant_id}/integrations/{id}

URI Parameters
HideShow
tenant_id
number (required) Example: 2262
id
string (required) Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
DELETE /v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
Requestsdeletes the tenant's integration

DELETE  /v3/tenants/2262/integrations/bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70

Headers
Accept: application/vnd.api+json
Content-Type: application/json
Responses204
This response has no content.

Delete
DELETE/v3/tenants/{tenant_id}/integrations/{id}

URI Parameters
HideShow
tenant_id
number (required) Example: 2262
id
string (required) Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70

Tenants

Assign User to the Unit as a Tenant

A user is assigned as a unit’s tenant by creating a tenancy. This can be achieved with API call: POST /v3/tenants

And sending following required attributes:

  • email (String) - must be a valid email address

  • first_name (String)

  • last_name (String)

  • unit_id (Integer)

Optional Attributes:

  • active_at (DateTime) - in ISO 8601 format e.g. 2017-12-27T11:03:50Z

  • inactive_at (DateTime)

  • pin (String)

  • directory_message (String)

  • display_name_strategy (String), one of the allowed values:

    • building
    • custom
    • first_name_and_last_name
    • first_name_initial_and_last_name
    • anonymous
    • first_name_and_last_name_initial

  • sms_notifications (Boolean)

  • email_notifications (Boolean)

  • preferences (Object)

    • calls (Object)
      • push (Boolean)
      • email (Boolean)
      • sms (Boolean)
    • door_opens (Object)
      • push (Boolean)
      • email (Boolean)
      • sms (Boolean)
    • messages (Object)
      • push (Boolean)
      • email (Boolean)
      • sms (Boolean)

  • do_not_disturb (Boolean)

  • skip_registration_email(Boolean)

When a valid email is submitted, then:

  • if there is no registered user in ButterflyMX with this email, a new user will be created and added as a tenant. Additionally, a registration e-mail will be sent to the users e-mail address unless skip_registration_email parameter is set to true

  • if there is a registered user with this email, an existing user will be added as a tenant (submitted attributes first_name and last_name will be ignored)

On success, server will respond with a 201 Created status code and a JSON API document.

Sortable fields:

  • created_at

Filterable fields:

  • display_name_strategy

  • display_only_on_search

  • pin_enabled

  • email_notifications

  • sms_notifications

  • do_not_disturb

Enumerations:

  • display_name_strategy:
    • building
    • custom
    • first_name_and_last_name
    • first_name_initial_and_last_name
    • anonymous
    • first_name_and_last_name_initial
GET /v3/tenants
Requestsshows a list of tenants

GET  /v3/tenants

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "2295",
      "type": "tenants",
      "attributes": {
        "active_at": "2022-07-26T09:35:29Z",
        "inactive_at": null,
        "qr_key_enabled": true,
        "delivery_pass_instructions": null,
        "directory_message": "District Government Administrator",
        "display_name": "Dario Williamson",
        "display_name_strategy": "building",
        "display_first_name": "Frances Gutmann",
        "display_last_name": "Tristan Vandervort",
        "display_only_on_search": false,
        "pin_enabled": false,
        "email_notifications": true,
        "sms_notifications": true,
        "do_not_disturb": false,
        "preferences": {
          "door_opens": {
            "push": false,
            "email": false,
            "sms": null
          },
          "messages": {
            "push": true,
            "email": false,
            "sms": false
          }
        }
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "337",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "99",
            "type": "users"
          }
        }
      }
    },
    {
      "id": "2294",
      "type": "tenants",
      "attributes": {
        "active_at": "2022-07-26T09:35:29Z",
        "inactive_at": null,
        "qr_key_enabled": true,
        "delivery_pass_instructions": null,
        "directory_message": "Construction Strategist",
        "display_name": "Charissa Purdy",
        "display_name_strategy": "building",
        "display_first_name": "Wilson Sawayn",
        "display_last_name": "Dino Roob",
        "display_only_on_search": true,
        "pin_enabled": false,
        "email_notifications": true,
        "sms_notifications": true,
        "do_not_disturb": false,
        "preferences": {
          "door_opens": {
            "push": false,
            "email": false,
            "sms": null
          },
          "messages": {
            "push": true,
            "email": false,
            "sms": false
          }
        }
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "337",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "98",
            "type": "users"
          }
        }
      }
    },
    {
      "id": "2293",
      "type": "tenants",
      "attributes": {
        "active_at": "2022-07-26T09:35:29Z",
        "inactive_at": null,
        "qr_key_enabled": true,
        "delivery_pass_instructions": null,
        "directory_message": "District Accounting Assistant",
        "display_name": "Seema Huel DVM",
        "display_name_strategy": "building",
        "display_first_name": "Mr. Ozzie Daniel",
        "display_last_name": "Man Schoen",
        "display_only_on_search": false,
        "pin_enabled": false,
        "email_notifications": true,
        "sms_notifications": true,
        "do_not_disturb": false,
        "preferences": {
          "door_opens": {
            "push": false,
            "email": false,
            "sms": null
          },
          "messages": {
            "push": true,
            "email": false,
            "sms": false
          }
        }
      },
      "relationships": {
        "unit": {
          "data": {
            "id": "337",
            "type": "units"
          }
        },
        "user": {
          "data": {
            "id": "97",
            "type": "users"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "99",
      "type": "users",
      "attributes": {
        "name": "Enrique Jacobi",
        "first_name": "Enrique",
        "last_name": "Jacobi",
        "contact_preference": "phone_call",
        "thumb_url": null,
        "medium_url": null,
        "sip_username": "99",
        "registration_status": "registered",
        "email": "jody.kirlin@gulgowski.info",
        "sms_phone_number": null,
        "phone_number": null
      }
    },
    {
      "id": "98",
      "type": "users",
      "attributes": {
        "name": "Osvaldo Ratke",
        "first_name": "Osvaldo",
        "last_name": "Ratke",
        "contact_preference": "phone_call",
        "thumb_url": null,
        "medium_url": null,
        "sip_username": "98",
        "registration_status": "registered",
        "email": "clark@prosacco.name",
        "sms_phone_number": null,
        "phone_number": null
      }
    },
    {
      "id": "97",
      "type": "users",
      "attributes": {
        "name": "Julia Toy",
        "first_name": "Julia",
        "last_name": "Toy",
        "contact_preference": "phone_call",
        "thumb_url": null,
        "medium_url": null,
        "sip_username": "97",
        "registration_status": "registered",
        "email": "jerry@wiegandfranecki.biz",
        "sms_phone_number": null,
        "phone_number": null
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/tenants?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/tenants?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/tenants?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

List
GET/v3/tenants

GET /v3/tenants/2296
Requestsshows the tenant

GET  /v3/tenants/2296

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2296",
    "type": "tenants",
    "attributes": {
      "active_at": "2022-07-26T09:35:30Z",
      "inactive_at": null,
      "qr_key_enabled": true,
      "delivery_pass_instructions": null,
      "directory_message": "Central Architect",
      "display_name": "Weldon Kunde",
      "display_name_strategy": "building",
      "display_first_name": "Kristian Runolfsson",
      "display_last_name": "Lovella Abernathy PhD",
      "display_only_on_search": true,
      "pin_enabled": false,
      "email_notifications": true,
      "sms_notifications": true,
      "do_not_disturb": false,
      "preferences": {
        "door_opens": {
          "push": false,
          "email": false,
          "sms": null
        },
        "messages": {
          "push": true,
          "email": false,
          "sms": false
        }
      }
    },
    "relationships": {
      "unit": {
        "data": {
          "id": "339",
          "type": "units"
        }
      },
      "user": {
        "data": {
          "id": "101",
          "type": "users"
        }
      }
    }
  },
  "included": [
    {
      "id": "101",
      "type": "users",
      "attributes": {
        "name": "Tuan Boyle",
        "first_name": "Tuan",
        "last_name": "Boyle",
        "contact_preference": "phone_call",
        "thumb_url": null,
        "medium_url": null,
        "sip_username": "101",
        "registration_status": "registered",
        "email": "kelly@schoen.com",
        "sms_phone_number": null,
        "phone_number": null
      }
    }
  ]
}

Show
GET/v3/tenants/{id}

URI Parameters
HideShow
id
number (required) Example: 2296
POST /v3/tenants
Requestscreates a tenantreturns bad request

POST  /v3/tenants

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "unit_id": 341,
      "email": "antony.swaniawski@jaskolskibrakus.com",
      "active_at": "2022-07-26T09:35:30Z"
    },
    "type": "tenants",
    "relationships": null
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2297",
    "type": "tenants",
    "attributes": {
      "active_at": "2022-07-26T09:35:30Z",
      "inactive_at": null,
      "qr_key_enabled": true,
      "delivery_pass_instructions": null,
      "directory_message": null,
      "display_name": "Schamberger, N.",
      "display_name_strategy": "building",
      "display_first_name": "Schamberger,",
      "display_last_name": "N.",
      "display_only_on_search": false,
      "pin_enabled": false,
      "email_notifications": false,
      "sms_notifications": false,
      "do_not_disturb": false,
      "preferences": {
        "door_opens": {
          "push": false,
          "email": false,
          "sms": null
        },
        "messages": {
          "push": true,
          "email": false,
          "sms": false
        }
      }
    },
    "relationships": {
      "unit": {
        "data": {
          "id": "341",
          "type": "units"
        }
      },
      "user": {
        "data": {
          "id": "103",
          "type": "users"
        }
      }
    }
  }
}

POST  /v3/tenants

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "unit_id": 343,
      "email": "",
      "first_name": "",
      "last_name": "User",
      "active_at": "2022-07-26T09:35:30Z"
    },
    "type": "tenants",
    "relationships": null
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/user"
      },
      "detail": "must exist"
    },
    {
      "source": {
        "pointer": "/data/attributes/user"
      },
      "detail": "can't be blank"
    }
  ]
}

Create
POST/v3/tenants

PATCH /v3/tenants/2298
Requestsupdates the tenantreturns bad request

PATCH  /v3/tenants/2298

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tenants",
    "id": "2298",
    "attributes": {
      "do_not_disturb": true
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2298",
    "type": "tenants",
    "attributes": {
      "active_at": "2022-07-26T09:35:30Z",
      "inactive_at": null,
      "qr_key_enabled": true,
      "delivery_pass_instructions": null,
      "directory_message": "Future Consulting Orchestrator",
      "display_name": "Dr. Chasidy Mayer",
      "display_name_strategy": "building",
      "display_first_name": "Mrs. Latanya Greenholt",
      "display_last_name": "Hyman Klein",
      "display_only_on_search": true,
      "pin_enabled": false,
      "email_notifications": true,
      "sms_notifications": true,
      "do_not_disturb": true,
      "preferences": {
        "door_opens": {
          "push": false,
          "email": false,
          "sms": null
        },
        "messages": {
          "push": true,
          "email": false,
          "sms": false
        }
      }
    },
    "relationships": {
      "unit": {
        "data": {
          "id": "345",
          "type": "units"
        }
      },
      "user": {
        "data": {
          "id": "107",
          "type": "users"
        }
      }
    }
  }
}

PATCH  /v3/tenants/2299

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tenants",
    "id": "2299",
    "attributes": {
      "display_name_strategy": ""
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/user_panel_config.display_name_strategy"
      },
      "detail": "can't be blank"
    }
  ]
}

Update
PATCH/v3/tenants/{id}

URI Parameters
HideShow
id
number (required) Example: 2298
DELETE /v3/tenants/2300
Requestsdeletes the tenant

DELETE  /v3/tenants/2300

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Delete
DELETE/v3/tenants/{id}

URI Parameters
HideShow
id
number (required) Example: 2300

Tours

Tour Schedules

Creating Tours consumes time slots. The number of time slots and the duration of a time slot is configurable in the PAC UI.

The consumed time slots can be reviewed with GET/v3/tours/{building_handle}/tour_schedules endpoint.

Times can be specified with AM/PM format timezone offsets, for example like this:

2021-04-16T02:00:00 PM -05:00 along with UTC time format described in the examples below.

GET /v3/tours/nikolaus-hoppe-415/tour_schedules
Requestsreturns building data with availabilities and taken time slots

GET  /v3/tours/nikolaus-hoppe-415/tour_schedules

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1392",
    "type": "buildings",
    "attributes": {
      "handle": "nikolaus-hoppe-415",
      "name": "Nikolaus-Hoppe-415",
      "slots": {
        "weekday_availabilities": {
          "mon": [
            [
              "09:00",
              "22:00"
            ]
          ],
          "wed": [
            [
              "09:00",
              "22:00"
            ]
          ],
          "fri": [
            [
              "09:00",
              "22:00"
            ]
          ]
        },
        "scheduled_slots": {
          "2020-12-14T13:00:00Z": 1,
          "2020-12-14T14:00:00Z": 1,
          "2020-12-14T19:00:00Z": 1
        },
        "reserved_slots": {
          "2020-12-14T12:00:00Z": 1
        },
        "blacked_out_slots": [
          {
            "starts_at": "2020-12-14T17:00:00Z",
            "ends_at": "2020-12-14T18:00:00Z"
          }
        ]
      },
      "slot_duration_minutes": 60,
      "max_simultaneous_bookings": 10,
      "time_window_days": 14,
      "address": {
        "country": "us",
        "address_1": "187 Bradtke Mountains",
        "address_2": "Emmittville, UT 19939-0039",
        "city": "Emmittville",
        "state": "Utah",
        "zip_code": "19939-0039",
        "phone_number": "(573) 436-7532"
      },
      "enabled": true,
      "tour_units": [],
      "unit_selection": false,
      "identity_verification": false,
      "key_locker_in_use": false,
      "shared_key_compartment_count": 0,
      "time_zone": "Etc/UTC",
      "time_zone_offset": "+00:00",
      "day_of_tour_text": null,
      "tos_text": null,
      "day_of_tour_text_draft": null,
      "credit_card_hold": false,
      "email_communication": true,
      "sms_communication": true,
      "enable_scheduling_portal": true
    }
  }
}

List
GET/v3/tours/{building_handle}/tour_schedules

URI Parameters
HideShow
building_handle
string (required) Example: nikolaus-hoppe-415
POST /v3/tours/gaylord-auer-and-becker-417/tour_schedules
Requestscreates a TourSchedulereturns bad request

POST  /v3/tours/gaylord-auer-and-becker-417/tour_schedules

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Gaylord, Auer and Becker-417 Tour",
      "email": "tour@example.com",
      "phone_number": "(555) 555-1234",
      "starts_at": "2020-12-14T12:00:00Z"
    },
    "type": "tour_schedules",
    "relationships": null
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "10",
    "type": "tour_schedules",
    "attributes": {
      "name": "Gaylord, Auer and Becker-417 Tour",
      "email": "tour@example.com",
      "starts_at": "2020-12-14T12:00:00Z",
      "ends_at": "2020-12-14T13:00:00Z",
      "uuid": "57cfb584-6a53-4bf9-9e51-8aa098978c47",
      "status": "confirmed",
      "qr_key_public_url": "http://user.butterflymx.test/public/gaylord-auer-and-becker-417/virtual_keys/39/2a0121e65a21d6e9cf1e5ac3788024e0",
      "pin": "755485",
      "qr_key_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium/qr_code_20201214-782-1d4r0e4.png",
      "phone_number": "(555) 555-1234",
      "building_handle": "gaylord-auer-and-becker-417",
      "building_name": "Gaylord, Auer and Becker-417",
      "building_address": {
        "country": "us",
        "address_1": "9835 Danette Creek",
        "address_2": "North Clorinda, FL 67776",
        "city": "North Clorinda",
        "state": "Florida",
        "zip_code": "67776",
        "phone_number": "516.755.6926 x716"
      },
      "tour_units": [],
      "day_of_tour_url": "http://selftours.butterflymx.test/tour/57cfb584-6a53-4bf9-9e51-8aa098978c47",
      "keychains": [],
      "key_locker_in_use": false
    }
  }
}

POST  /v3/tours/abbott-rodriguez-and-kreiger-419/tour_schedules

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "name": "Abbott, Rodriguez and Kreiger-419 Tour ",
      "email": "tour@example.com",
      "starts_at": "2020-12-15T11:00:00Z"
    },
    "type": "tour_schedules",
    "relationships": null
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/starts_at"
      },
      "detail": "is not available, outside availability hours"
    }
  ]
}

Create
POST/v3/tours/{building_handle}/tour_schedules

URI Parameters
HideShow
building_handle
string (required) Example: gaylord-auer-and-becker-417
GET /v3/tours/bf9fd251-edc3-45ae-97fd-b55583156f63
Requestsreturns success

GET  /v3/tours/bf9fd251-edc3-45ae-97fd-b55583156f63

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "11",
    "type": "tour_schedules",
    "attributes": {
      "name": "Confirmed Tour",
      "email": "guest@example.com",
      "starts_at": "2020-12-14T12:00:00Z",
      "ends_at": "2020-12-14T13:00:00Z",
      "uuid": "bf9fd251-edc3-45ae-97fd-b55583156f63",
      "status": "confirmed",
      "qr_key_public_url": null,
      "pin": null,
      "qr_key_image_url": null,
      "phone_number": "1-772-724-9177",
      "building_handle": "cremin-and-sons-421",
      "building_name": "Cremin and Sons-421",
      "building_address": {
        "country": "us",
        "address_1": "95108 Champlin Highway",
        "address_2": "South Reuben, CA 00431-0467",
        "city": "South Reuben",
        "state": "California",
        "zip_code": "00431-0467",
        "phone_number": "(669) 929-6015"
      },
      "tour_units": [],
      "day_of_tour_url": "http://selftours.butterflymx.test/tour/bf9fd251-edc3-45ae-97fd-b55583156f63",
      "keychains": [],
      "key_locker_in_use": false
    }
  }
}

Show
GET/v3/tours/{uuid}

URI Parameters
HideShow
uuid
string (required) Example: bf9fd251-edc3-45ae-97fd-b55583156f63
PATCH /v3/tours/01c75535-4c04-4401-b36f-0078704f85ff
Requestsupdates the TourSchedule starts_at and changes status to rescheduled

PATCH  /v3/tours/01c75535-4c04-4401-b36f-0078704f85ff

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tour_schedules",
    "id": "12",
    "attributes": {
      "starts_at": "2020-12-16T12:00:00Z"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "12",
    "type": "tour_schedules",
    "attributes": {
      "name": "Confirmed Tour",
      "email": "guest@example.com",
      "starts_at": "2020-12-16T12:00:00Z",
      "ends_at": "2020-12-16T13:00:00Z",
      "uuid": "01c75535-4c04-4401-b36f-0078704f85ff",
      "status": "rescheduled",
      "qr_key_public_url": "http://user.butterflymx.test/public/pacocha-kovacek-and-runolfsson-423/virtual_keys/40/69138c7e68c44ea6df77df014408b334",
      "pin": "495316",
      "qr_key_image_url": "https://bmx-rails-staging.s3.amazonaws.com/system/uploads/test-1-1658827910-12de3eca9ce00ffcec7b1e4671a272d1/store/medium/qr_code_20201214-782-8r2lbp.png",
      "phone_number": "517-539-7712",
      "building_handle": "pacocha-kovacek-and-runolfsson-423",
      "building_name": "Pacocha, Kovacek and Runolfsson-423",
      "building_address": {
        "country": "us",
        "address_1": "96449 Langosh Grove",
        "address_2": "New Nydiaville, VA 02417",
        "city": "New Nydiaville",
        "state": "Virginia",
        "zip_code": "02417",
        "phone_number": "271.989.5177 x33915"
      },
      "tour_units": [],
      "day_of_tour_url": "http://selftours.butterflymx.test/tour/01c75535-4c04-4401-b36f-0078704f85ff",
      "keychains": [],
      "key_locker_in_use": false
    }
  }
}

Update
PATCH/v3/tours/{uuid}

URI Parameters
HideShow
uuid
string (required) Example: 01c75535-4c04-4401-b36f-0078704f85ff
DELETE /v3/tours/00cf7a10-9df2-460a-bace-985756e5b046
Requestschanges the TourSchedule status to cancelled

DELETE  /v3/tours/00cf7a10-9df2-460a-bace-985756e5b046

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "13",
    "type": "tour_schedules",
    "attributes": {
      "name": "Confirmed Tour",
      "email": "guest@example.com",
      "starts_at": "2020-12-14T12:00:00Z",
      "ends_at": "2020-12-14T13:00:00Z",
      "uuid": "00cf7a10-9df2-460a-bace-985756e5b046",
      "status": "cancelled",
      "qr_key_public_url": null,
      "pin": null,
      "qr_key_image_url": null,
      "phone_number": "1-400-332-0993",
      "building_handle": "bernhard-nolan-and-shanahan-425",
      "building_name": "Bernhard, Nolan and Shanahan-425",
      "building_address": {
        "country": "us",
        "address_1": "16491 Champlin Falls",
        "address_2": "New Leonor, VA 31364-8969",
        "city": "New Leonor",
        "state": "Virginia",
        "zip_code": "31364-8969",
        "phone_number": "565-643-3308"
      },
      "tour_units": [],
      "day_of_tour_url": "http://selftours.butterflymx.test/tour/00cf7a10-9df2-460a-bace-985756e5b046",
      "keychains": [],
      "key_locker_in_use": false
    }
  }
}

Delete
DELETE/v3/tours/{uuid}

URI Parameters
HideShow
uuid
string (required) Example: 00cf7a10-9df2-460a-bace-985756e5b046

Units

Units

Unit creation

  • When creating a unit, a building_id needs to be sent alongside the units attributes, so a unit can be assigned to a building.

Includeable resources:

  • building

  • users

Filterable fields:

  • floor_number (integer)

  • kind (enumeration)

  • label (string)

Sortable fields:

  • id

  • floor_number

  • kind

  • label

  • updated_at

  • created_at

Enumerations:

  • kind:
    • residential
    • commercial
GET /v3/units/370
Requestsshows the unit

GET  /v3/units/370

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "370",
    "type": "units",
    "attributes": {
      "kind": "residential",
      "label": "56056",
      "floor_number": 56
    },
    "relationships": {
      "building": {
        "data": {
          "id": "1404",
          "type": "buildings"
        }
      },
      "users": {
        "data": []
      }
    }
  }
}

Show
GET/v3/units/{id}

URI Parameters
HideShow
id
number (required) Example: 370
GET /v3/units
Requestsshows a list of tenantsshows a list of tenants with included resources

GET  /v3/units

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "374",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "59059",
        "floor_number": 59
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1406",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    },
    {
      "id": "373",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "58058",
        "floor_number": 58
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1406",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    },
    {
      "id": "372",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "57057",
        "floor_number": 57
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1406",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    },
    {
      "id": "371",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "00",
        "floor_number": 0
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1406",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/units?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/units?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/units?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

GET  /v3/units?include=users,building

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "378",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "62062",
        "floor_number": 62
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1407",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    },
    {
      "id": "377",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "61061",
        "floor_number": 61
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1407",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    },
    {
      "id": "376",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "60060",
        "floor_number": 60
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1407",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    },
    {
      "id": "375",
      "type": "units",
      "attributes": {
        "kind": "residential",
        "label": "00",
        "floor_number": 0
      },
      "relationships": {
        "building": {
          "data": {
            "id": "1407",
            "type": "buildings"
          }
        },
        "users": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "1407",
      "type": "buildings",
      "attributes": {
        "name": "Goodwin-Willms-430",
        "building_type": "multi_family",
        "display_name_strategy": "last_name_and_first_name_initial",
        "qr_key_enabled": true,
        "nfc_enabled": false,
        "send_panel_status_report": false,
        "mobile_logo_picture": {
          "thumb_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png",
          "medium_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png"
        },
        "panel_logo_picture": {
          "thumb_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png",
          "medium_url": "/assets/BMX_logo-950095e4e7500998fa6993f28f8950cba6f2322a76806abb7820fa39eb6394b6.png"
        },
        "address_1": "14678 Rippin Ports",
        "address_2": "Lake Derickmouth, NJ 26620-9003",
        "city": "Lake Derickmouth",
        "state": "New Jersey",
        "zip_code": "26620-9003",
        "phone_number": "674.805.4282",
        "country": "us",
        "time_zone": "Etc/UTC",
        "time_zone_offset": "+00:00",
        "delivery_pass_enabled": true,
        "door_release_pin": true,
        "open_door_button_enabled": true
      }
    }
  ],
  "links": {
    "self": "http://api.butterflymx.com/v3/units?include=users%2Cbuilding&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "http://api.butterflymx.com/v3/units?include=users%2Cbuilding&page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "http://api.butterflymx.com/v3/units?include=users%2Cbuilding&page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

List
GET/v3/units

POST /v3/buildings/1408/units
Requestscreates the unitreturns bad requestreturns not found

POST  /v3/buildings/1408/units

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "attributes": {
      "kind": "residential",
      "label": "foo",
      "floor_number": 11
    },
    "type": "units",
    "relationships": null
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "380",
    "type": "units",
    "attributes": {
      "kind": "residential",
      "label": "foo",
      "floor_number": 11
    },
    "relationships": {
      "building": {
        "data": {
          "id": "1408",
          "type": "buildings"
        }
      },
      "users": {
        "data": []
      }
    }
  }
}

POST  /v3/buildings/1409/units

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "units",
    "attributes": {
      "kind": "residential"
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/label"
      },
      "detail": "can't be blank"
    },
    {
      "source": {
        "pointer": "/data/attributes/floor_number"
      },
      "detail": "can't be blank"
    },
    {
      "source": {
        "pointer": "/data/attributes/floor_number"
      },
      "detail": "is not a number"
    }
  ]
}

POST  /v3/buildings/DOES_NOT_EXIST/units

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "units",
    "attributes": {
      "kind": "residential",
      "label": "foo",
      "floor_number": 11
    }
  }
}
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "title": "Record not found",
      "detail": "Requested record could not be found"
    }
  ]
}

Create
POST/v3/buildings/{building_id}/units

URI Parameters
HideShow
building_id
number (required) Example: 1408
PUT /v3/units/385
Requestsupdates the unitreturns bad request

PUT  /v3/units/385

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "units",
    "attributes": {
      "kind": "residential",
      "label": "New Label",
      "floor_number": 11,
      "building_id": 1411
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "385",
    "type": "units",
    "attributes": {
      "kind": "residential",
      "label": "New Label",
      "floor_number": 11
    },
    "relationships": {
      "building": {
        "data": {
          "id": "1411",
          "type": "buildings"
        }
      },
      "users": {
        "data": []
      }
    }
  }
}

PUT  /v3/units/388

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "units",
    "attributes": {
      "label": ""
    }
  }
}
Responses400
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/label"
      },
      "detail": "can't be blank"
    }
  ]
}

Update
PUT/v3/units/{id}

URI Parameters
HideShow
id
number (required) Example: 385
DELETE /v3/units/391
Requestsdeletes a unit

DELETE  /v3/units/391

Headers
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Delete
DELETE/v3/units/{id}

URI Parameters
HideShow
id
number (required) Example: 391

Generated by aglio on 26 Jul 2022