API Documentation (1.0)

Download OpenAPI specification:Download

ButterflyMX API V3

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

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)

List

header Parameters
Accept
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Show

path Parameters
id
number
Example: 845676947
header Parameters
Accept
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{}

Update

path Parameters
id
number
Example: 845676951
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{}

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

List

path Parameters
building_id
number
Example: 1337
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Create

path Parameters
building_id
number
Example: 1337
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Show

path Parameters
building_id
number
Example: 1337
id
string
Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Update

path Parameters
building_id
number
Example: 1337
id
string
Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Delete

path Parameters
building_id
number
Example: 1337
id
string
Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

List

path Parameters
tenant_id
number
Example: 2262
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Create

path Parameters
tenant_id
number
Example: 2262
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {}
}

Show

path Parameters
tenant_id
number
Example: 2262
id
string
Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Update

path Parameters
tenant_id
number
Example: 2262
id
string
Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Delete

path Parameters
tenant_id
number
Example: 2262
id
string
Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

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

Call Status

path Parameters
call_guid
string
Example: a77d331e-6535-49c7-9701-a2fc618e6984
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    },
  • "included": [
    ]
}

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

Calls

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": [
    ],
}

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

Door Releases

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

List

header Parameters
Accept
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": [
    ],
}

Messages

Sortable fields:

  • message_type
  • created_at

Filterable fields:

  • message_type -> enum

Enumerations:

  • message_type:
    • text
    • voice

Messages

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8

Open Door

Open Door

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{
  • "data": {
    }
}

Open Door

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Tokens

Create

path Parameters
call_guid
string
Example: twiliotest
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{
  • "tokens": {
    }
}

User

Resources that can be included:

  • tenants

Nested resources that can be included:

  • tenants.building
  • tenants.unit
  • tenants.panels

Show

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{
  • "data": {
    }
}

Update

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

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

List

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": [ ]
}

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

Door Releases

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

List

header Parameters
Accept
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": [
    ],
}

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

Create Custom Keychain

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{}

List

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{
  • "data": [
    ],
}

Show

path Parameters
id
number
Example: 940364953
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Delete

path Parameters
id
number
Example: 940364954
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Create One-Time Keychain

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Create Recurring Keychain

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{}

Virtual Keys

Create

path Parameters
keychain_id
number
Example: 940364957
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Delete

path Parameters
keychain_id
number
Example: 940364960
id
number
Example: 1035872614
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Call Accepted

Call Accepted

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Call Ended

Call Ended

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Is Active

Is Active

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Open Door

Open Door

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
Example
{
  • "data": {
    }
}

Open Door

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Toggle Camera

Toggle Camera

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

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)

Combine

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Show

path Parameters
id
number
Example: 990619299
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Set

header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/vnd.api+json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "errors": [
    ]
}

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

List

path Parameters
building_id
number
Example: 1337
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Create

path Parameters
building_id
number
Example: 1337
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Show

path Parameters
building_id
number
Example: 1337
id
string
Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Update

path Parameters
building_id
number
Example: 1337
id
string
Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Delete

path Parameters
building_id
number
Example: 1337
id
string
Example: 79c9dc15-1bef-4ecc-956e-824be46901ce
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

List

path Parameters
tenant_id
number
Example: 2262
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{}

Create

path Parameters
tenant_id
number
Example: 2262
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {}
}

Show

path Parameters
tenant_id
number
Example: 2262
id
string
Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json

Responses

Response samples

Content type
application/vnd.api+json; charset=utf-8
{
  • "data": {
    }
}

Update

path Parameters
tenant_id
number
Example: 2262
id
string
Example: bb7b0ec9-8b2f-46c4-a1c7-4bf439ca4c70
header Parameters
Accept
any
Example: application/vnd.api+json
Content-Type
any
Example: application/json
Request Body schema: application/vnd.api+json
Schema not provided

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json; charset=utf-8
{