Users Sign Up Collection
Users Confirmation Collection
Users Sign In Collection
Users Sign Out Collection
Users Password Collection
User Collection
Two Factor Authentication
Groups Collection
Groups Member
GroupLocks Collection
GroupLocks Member
Shares Collection
Shares Member
Integrations Collection
Integrations Member
Beacons Collection
Beacons Member
Card Readers Collection
Card Readers Member
Contact Sensors Collection
Contact Sensors Member
Relays Collection
Relays Member
Request To Exits Collection
Request To Exits Member
Wireless Locks Collection
Wireless Locks Member
Event Exports Collection
Event Exports Member
Notifications Collection
Notifications Member
Analytics Events Collection
Analytics Gateways Collection
Plans Collection
Plans Member
Subscriptions Collection
Subscriptions Member

Overview


Welcome to the Kisi API specification! In this document, we will guide you through the process of interacting with the Kisi API all the way from creating a user to unlocking a door. We will explain the different concepts and how you can sign up, in and out, as well as manage your logins, places, lock and much more.

Contents

The API specification is divided into four parts. Part 1 (Setup) will provide necessary information on how to setup a development environment so you can interface with the API, part 2 (Tutorial) will guide you through Kisi’s main domain concepts and Part 3 (Endpoints) is the reference for all the supported calls to the Kisi API, including error handling and concerns such as pagination.

Contact

If you have any questions before you start integrating, or if questions come up during reading, please drop us an email (support@getkisi.com) or join our Gitter dev channel (https://gitter.im/Kisi-inc/Lobby).

Setup

This part of the API documentation will help you set up a basic environment for interfacing with the Kisi API.

Access

To access, the API, you have several options. For example:

  • Use the web interface of Apiary in the Endpoints section of this documentation

  • Use our official JavaScript client SDK, which is a thin but helpful API wrapper for HTTP (https://github.com/kisi-inc/client-js)

  • Use the Postman Chrome extension to perform API calls from your Chrome browser

Interaction

To interact with the Kisi API, you have to dispatch secure HTTP requests. Most programming languages have built in client libraries for creating HTTP requests and dealing with their responses.

If you’re using JavaScript, have a look at our above mentioned official JavaScript API client. It supports all of the API’s endpoints, though in a very basic manner. It also provides authentication helpers and sets relevant JSON headers as well as authentication headers automatically so you won’t have to do it. The source code and example usage can be found here: https://github.com/kisi-inc/client-js.

Format

The Kisi API supports JSON only, so please set Accept and Content-Type to application/json. All requests and responses will use JSON as the format for any data encompassed in the body of requests and responses.

<METHOD> <URL> HTTP/1.1
Accept: application/json
Content-Type: application/json

Authentication

Most calls to the API will require an authenticated user. If such a user is not present, you will receive a 401 response. To sign in, you will have to create a user and confirm the user first. Once you have signed up and confirmed, you will need to create a login by signing in. You will receive am access token which needs to be included in subsequent calls to the API in the Authorization header field:

<METHOD> <URL> HTTP/1.1
Authorization: KISI-LOGIN <secret>
Accept: application/json
Content-Type: application/json

Tutorial

To use the Kisi API, it is helpful to understand the domain concepts behind its features. In this section, we’ll guide you through the main concepts: users, places, locks and shares. We’ll also introduce you to other features of the API such as groups. Our aim is to acquaint you with the domain concepts in a way that prepares you for building your own apps that leverage the Kisi API. We’ll provide you with request and/or code samples as we go, so you can try it out yourself right away.

Please observe: to use the Kisi API JavaScript client as demonstrated in the examples to follow, you first need to instantiate it:

import Kisi from "kisi-client"

const kisiClient = new Kisi(required, )

Users

Anyone wishing to use Kisi needs to complete sign up first. All it takes to become a user with Kisi is an email address, a password and a confirmation email (and don’t forget to accept the terms and conditions). Since we tie access rights to email addresses (required, for now), it is imperative that users confirm their email addresses before signing in.

Sign Up

The body of the HTTPS request to the Kisi API to create a User object can be as simple as:

{
  "user": {
    "name": "First Last",
    "email": "email@domain.com",
    "password": "test1234",
    "terms_and_conditions": true
  }
}

Or with the JavaScript client:

kisiClient
  .signUp("email@domain.com", "test1234")
  .then(user => console.log(user)) // the created user
  .catch(error => console.log(error)) // any error

Within seconds you should receive a confirmation email. Follow its instructions to confirm. If you wish to programmatically parse the email and confirm the user, you need extract the confirmation token:

https://my.getkisi.com/#/users/confirmation?confirmation_token=bQBxyMTKyX5FvzARM16M

In this example, the token is bQBxyMTKyX5FvzARM16M. Use it when you call the confirmation endpoint.

Sign In

Once the user has been confirmed, sign in to create a Login object containing a secret that must be used for subsequent, access restricted calls to the API.

The payload of the request:

{
  "user": {
    "email": "email@domain.com",
    "password": "test1234"
  }
}

The payload of the response (required, abrigded):

{
  "secret": "secret"
}

Or with the JavaScript client:

kisiClient
  .signIn("email@domain.com", "test1234")
  .then(user => console.log(user)) // automatically sets authentication header
  .catch(error => console.log(error)) // any error

If you’re using the JavaScript SDK, you’re all set. If you’re creating your HTTP requests manually, set the Authorization header on subsequent calls:

Authorization: KISI-LOGIN <token>

Sign Out

To sign out, just call the sign out endpoint with the authentication header set - a payload is not required.

Or with the JavaScript client:

kisiClient
  .signIn("email@domain.com", "test1234")
  .then(user => console.log(user)) // deletes login on the server and signs out
  .catch(error => console.log(error)) // any error

Places

To set up Kisi, you need to create a user account (required, see Users) and three more items: a place, a gateway (required, see Gateways) and a lock (required, see Locks). Gateways connect your real world door to its counterpart in Kisi, the locks. Gateways and locks belong to places, so we’ll focus on creating a place first.

Heads up: If you wish to grant access to a user, that user does not need to create a place. Instead, you share an existing place with the user by creating a share (required, see Shares).

So, what constitutes a place? A place represents any physical space (office, building, …) that uses Kisi for unlocking doors. It has a name and an address among other attributes, and belongs to the user that created it. Its creator is called owner, and only the owner has all the rights on the place.

To create a place, pass in the necessary attributes to a POST call to the create place endpoint. The API will return the place you created, remember to write down the id so you can use it later. Example payload:

{
  "place": {
    "name": "My 1st Kisi Place",
    "address": "63 Flushing Ave, New York City 11205 USA"
  }
}

Or with the JavaScript client:

const place = {
  name: "My 1st Kisi Place",
  address: "63 Flushing Ave, New York City 11205 USA"
}

kisiClient
  .post("places", { place })
  .then(place => console.log(place)) // the created place
  .catch(error => console.log(error)) // any error

Now that you have created a place, we can go on to creating gateways and locks.

Gateways

Gateways are the API’s representation of physical Kisi devices installed at your space. While it is possible to create these using the API, usually this approach alone won’t work as your devices won’t have any Wi-Fi credentials when they are shipped.

Therefore, to create a Kisi device, you have to perform a blinkup with our Android or iOS app first. Once the blinkup has been completed, the app will create the gateway for you.

Find out more about the blinkup here: https://support.getkisi.com/onboarding/step-2.

Locks

The final missing piece on our journey towards our first unlock is the lock. It represents anything in the real world that can be accessed using a Kisi router. To create a lock, simply send a post request to the create locks endpoint. Example payload:

{
  "lock": {
    "name": "My 1st Kisi Lock",
    "unlock_channel": 5,
    "unlock_duration": 5.0,
    "place_id": 1
  }
}

Or with the JavaScript client:

const lock = {
  name: "My 1st Kisi Lock",
  unlock_channel: 5,
  unlock_duration: 5.0,
  place_id: 1
}

kisiClient
  .post("locks", { lock })
  .then(lock => console.log(lock)) // the created lock
  .catch(error => console.log(error)) // any error

The unlock_commands is the physical relay used to trigger the unlock. Usually, your installer will give you this information. Otherwise, contact us and we’ll help you set it up.

With the lock created, let’s unlock it! We don’t need to send along any values to the unlock locks endpoint unless you’ve enabled certain restrictions, e.g. reader restrictions. In that case, you need to send along your client context - find out more about this in the API docs.

{}

Or with the JavaScript client:

kisiClient
  .post("locks/1/unlock", {})
  .then(result => console.log(result)) // the result
  .catch(error => console.log(error)) // any error

If your unlock failed, you will get an error result back. Check the errors section of the documentation for more information.

Shares

If you’re not the only one to ever use Kisi in your space, then you’ll need to share access with other Kisi users. Sharing access works based on email addresses (required, for now), so you’ll need to know the email address of the person you’re sharing access with. You can grant access on three different items: (required, entire) places, groups and locks. We’ll get to groups later, let’s share access for places and locks first.

Let’s grant access to a guest user with the email address guest@domain.com and grant access for the entire place (i.e. all of the place’s locks). Example payload:

{
  "share": {
    "email": "guest@domain.com",
    "apply_to_place": true,
    "place_id": 1
  }
}

Or with the JavaScript client:

const share = {
  email: "guest@domain.com",
  apply_to_place: true,
  place_id: 1
}

kisiClient
  .post("shares", { share })
  .then(share => console.log(share)) // the share
  .catch(error => console.log(error)) // any error

To share access with just a lock, remove the apply_to_place property, and add a lock_id property with the value set to your lock’s id. You don’t have to set the place id in this case, the API will infer it based on the lock.

{
  "share": {
    "email": "guest@domain.com",
    "lock_id": 1
  }
}

Groups

For more than just simple scenarios, you will probably want to grant access more granularly based on real world access permissions of your users. For example, guest users should only be allowed to access between 9AM and 5PM on weekdays, whereas members should be allowed access at all times. Also, guests may not access garage doors, while members may.

This is where groups come in handy. Groups share a specific set of locks with a specific set of users that you define. For example:

  • Group Guests: access from 9AM-5PM on weekdays sharing lock “Entrance” to all guest users

  • Group Members: access from 9AM-5PM every day sharing lock “Entrance” and “Garage” to all member users

Let’s create the members group by posting a request to the create groups endpoint with the following payload:

{
  "group": {
    "name": "Members",
    "time_restriction_enabled": true,
    "time_restriction_time_zone": "Stockholm",
    "time_restriction_time_slots": {
      "weekday": 1,
      "allowed_from": 540,
      "allowed_until": 1020
    },
    "time_restriction_time_slots": {
      "weekday": 2,
      "allowed_from": 540,
      "allowed_until": 1020
    },
    "time_restriction_time_slots": {
      "weekday": 3,
      "allowed_from": 540,
      "allowed_until": 1020
    },
    "time_restriction_time_slots": {
      "weekday": 4,
      "allowed_from": 540,
      "allowed_until": 1020
    },
    "time_restriction_time_slots": {
      "weekday": 5,
      "allowed_from": 540,
      "allowed_until": 1020
    },
    "place_id": 1
  }
}

We omit the JavaScript examples from now on - check previous examples on how to use the JavaScript client SDK.

With the group created, you can add locks to it. We assume that you already created a lock in the previous parts of this section, so let’s focus on the call to assign a lock to a group. Simply post a request to the create group lock endpoint with this payload:

{
  "group_lock": {
    "group_id": 1,
    "lock_id": 1
  }
}

Now that you have created a group and added a lock to it, you’ll want to add users to this group. To do so, create a share that grants access to this group:

{
  "share": {
    "email": "member@domain.com",
    "group_id": 1
  }
}

And done!

Events

Now that users have started unlocking the locks at your place, you might find to find out more about how Kisi is used. To get a list of recent events, simply dispatch a get call to the events index endpoint.

Integrations

Integrations with 3rd party services and other outward going features of the Kisi API.

Webhooks

Assumption: a webhook type integration already exists and is enabled.

Request

The request will be POSTed to the URL specified in the integration. Its contents will contain the following fields (required, example values):

{
  "actor_type": "User",
  "actor_id": 1,
  "action": "unlock",
  "object_type": "Lock",
  "object_id": 1,
  "success": "true",
  "code": "ffffff",
  "message": "carl@kisi.io unlocked lock Entrance Door",
  "references": [
    {
      "type": "Place",
      "id": 1
    },
    {
      "type": "Lock",
      "id": 1
    }
  ],
  "created_at": ""
}

The Content-Type header will be set to application/json.

Response

Please respond to the webhook with a 2xx status. The call will time out after six seconds.

Pagination

Limit

Query parameters, how many results to return.

Offset

Query parameters, how many items to skip (e.g. to go to next page).

Errors

What error codes you can expect and what they contain.

401 Unauthorized

API unable to authenticate the user (required, unable to verify who the user is).

{
  "code": "abc123",
  "error": "More info"
}

403 Forbidden

API unable to authorize the user (required, user not allowed to perform request).

{
  "code": "abc123",
  "error": "More info"
}

404 Not Found

API unable to find requested resource.

API unable to perform request at the moment.

{
  "code": "abc123",
  "error": "More info"
}

422 Unprocessable entity

API unable to proceed due to invalid parameters.

{
  "errors": {
    "field0": [
      "array",
      "of",
      "error",
      "messages"
    ],
    "field1": [
      "array",
      "of",
      "error",
      "messages"
    ]
  }
}

503 Service Unavailable

API unable to perform request at the moment.

{
  "code": "abc123",
  "error": "More info"
}

Endpoints

Please see Reference for the endpoints.

Users

Users.

Users Sign Up Collection

Create

Create.

REQUEST

Parameters
sign_up_token string sign_up_token -
Headers
Content-Type application/json
Accept application/json
application/json
                          {
  "user": {
    "email": "email",
    "password": "password",
    "terms_and_conditions": true,
    "name": "name",
    "image": "image"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "terms_and_conditions": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string"
        }
      },
      "required": [
        "email",
        "password",
        "terms_and_conditions"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "email": "email",
  "name": "name",
  "public_id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "public_id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "email",
    "name",
    "public_id",
    "created_at",
    "updated_at"
  ]
}
                      

Show

Show.

REQUEST

Parameters
sign_up_token string sign_up_token -
Headers
Content-Type application/json
Accept application/json

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "email": "email"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "required": [
    "email"
  ]
}
                      
Users Confirmation Collection

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
application/json
                          {
  "user": {
    "email": "email"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      },
      "required": [
        "email"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Show

Show.

REQUEST

Parameters
confirmation_token string abc123 -
Headers
Content-Type application/json
Accept application/json

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "email": "email",
  "name": "name"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "email",
    "name"
  ]
}
                      
Users Sign In Collection

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
application/json
                          {
  "user": {
    "email": "email",
    "password": "password",
    "otp_attempt": "123456",
    "backup_otp_attempt": "123456"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "otp_attempt": {
          "type": "string"
        },
        "backup_otp_attempt": {
          "type": "string"
        }
      },
      "required": [
        "email",
        "password"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "secret": "secret",
  "user_id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "secret": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "secret",
    "user_id",
    "created_at",
    "updated_at",
    "user"
  ]
}
                      
Users Sign Out Collection

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json

RESPONSE

Headers
Content-Type application/json
Users Password Collection

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
application/json
                          {
  "user": {
    "email": "email"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      },
      "required": [
        "email"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Update

Update.

REQUEST

Headers
Content-Type application/json
Accept application/json
application/json
                          {
  "user": {
    "password": "password",
    "password_confirmation": "password",
    "reset_password_token": "reset_password_token"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "password": {
          "type": "string"
        },
        "password_confirmation": {
          "type": "string"
        },
        "reset_password_token": {
          "type": "string"
        }
      },
      "required": [
        "password",
        "password_confirmation",
        "reset_password_token"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
User Collection

Show

Show.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "email": "email",
  "image": "image",
  "name": "name",
  "public_id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "image": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "public_id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "email",
    "name",
    "public_id",
    "created_at",
    "updated_at"
  ]
}
                      

Update

Update.

REQUEST

Headers
Content-Type application/json
Accept application/json
application/json
                          {
  "user": {
    "current_password": "password",
    "password": "password",
    "password_confirmation": "password",
    "name": "name",
    "image": "image"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "current_password": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "password_confirmation": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string"
        }
      },
      "required": [
        "current_password"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Headers
Content-Type application/json
Accept application/json

RESPONSE

Headers
Content-Type application/json
Two Factor Authentication

Create OTP Secret

Generates and returns an OTP secret that can be used to set up e.g. the Google Authenticator app to generate 2FA codes.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization Basic <Encoded Credentials>, KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
201 application/json
                        {
  "uri": "otpauth://Kisi:user@example.com?secret=secret&issuer=Kisi",
  "otp_secret": "secret"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "uri": {
      "type": "string"
    },
    "otp_secret": {
      "type": "string"
    }
  },
  "required": [
    "uri",
    "otp_secret"
  ]
}
                      

Activate

Activate.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization Basic <Encoded Credentials>, KISI-LOGIN <secret>
application/json
                          {
  "user": {
    "otp_attempt": "343536"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "otp_attempt": {
          "type": "string"
        }
      },
      "required": [
        "otp_attempt"
      ]
    }
  },
  "required": [
    "user"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Deactivate

Deactivate.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization Basic <Encoded Credentials>, KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Create Backup Codes

Create backup codes.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization Basic <Encoded Credentials>, KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "backup_codes": [
    "343536",
    "565678",
    "838103",
    "1012934"
  ]
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "backup_codes": {
      "type": "array"
    }
  },
  "required": [
    "backup_codes"
  ]
}
                      
Logins

Logins.

Logins Collection

Index

Retrieves all logins the user is allowed to see.

REQUEST

Parameters
type string type -
primary boolean true -
user_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "primary": false,
  "last_used_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "secret": "secret"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "primary": {
      "type": "boolean"
    },
    "last_used_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "secret": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "user",
    "secret"
  ]
}
                      

Create

Creates a login.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>
application/json
                          {
  "login": {
    "name": "name",
    "type": "device",
    "push_token": "token"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "login": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "push_token": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "login"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "primary": false,
  "last_used_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "secret": "secret"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "primary": {
      "type": "boolean"
    },
    "last_used_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "secret": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "user",
    "secret"
  ]
}
                      
Login Member

Show

Show.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "primary": false,
  "last_used_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "primary": {
      "type": "boolean"
    },
    "last_used_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "user"
  ]
}
                      

Update

Update.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>
application/json
                          {
  "login": {
    "name": "name",
    "push_token": "token"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "login": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "push_token": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "login"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json

Promote

Promote.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json
Logins Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "primary": false,
  "last_used_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "primary": {
      "type": "boolean"
    },
    "last_used_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "user"
  ]
}
                      

Destroy

Destroy.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json

Promote

Promote.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <Secret>

RESPONSE

Headers
Content-Type application/json
Places

Places.

Places Collection

Index

Index.

REQUEST

Parameters
query string query -
user_id number 0 -
transfer_to_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "address": "address",
    "color": "color",
    "image": "image",
    "logo": "logo",
    "tz_time_zone": "tz_time_zone",
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "time_restriction_enabled": true,
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 100,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ],
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "transfer_to": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "user": {
      "id": 0,
      "email": "email",
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "place": {
    "name": "name",
    "address": "address",
    "color": "color",
    "image": "image",
    "logo": "logo",
    "tz_time_zone": "tz_time_zone",
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "time_restriction_enabled": true,
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 100,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ]
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "place": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "address": {
          "type": "string"
        },
        "color": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        },
        "time_zone: `time_zone`": {
          "type": "string"
        },
        "tz_time_zone": {
          "type": "string"
        },
        "primary_device_restriction_enabled": {
          "type": "boolean"
        },
        "reader_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_radius": {
          "type": "number"
        },
        "time_restriction_time_slots": {
          "type": "array"
        }
      },
      "required": [
        "name",
        "address"
      ]
    }
  },
  "required": [
    "place"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "address": "address",
  "color": "color",
  "image": "image",
  "logo": "logo",
  "tz_time_zone": "tz_time_zone",
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "time_restriction_enabled": true,
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 100,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "transfer_to": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "color": {
      "type": "string"
    },
    "image": {
      "type": "string"
    },
    "logo": {
      "type": "string"
    },
    "time_zone: `time_zone`": {
      "type": "string"
    },
    "tz_time_zone": {
      "type": "string"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "transfer_to": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "address",
    "created_at",
    "updated_at",
    "user"
  ]
}
                      
Places Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret> || KISI-LINK token=<LINK TOKEN>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "address": "address",
  "color": "color",
  "image": "image",
  "logo": "logo",
  "tz_time_zone": "tz_time_zone",
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "time_restriction_enabled": true,
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 100,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "transfer_to": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "color": {
      "type": "string"
    },
    "image": {
      "type": "string"
    },
    "logo": {
      "type": "string"
    },
    "time_zone: `time_zone`": {
      "type": "string"
    },
    "tz_time_zone": {
      "type": "string"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "transfer_to": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "address",
    "created_at",
    "updated_at",
    "user"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "place": {
    "name": "name",
    "address": "address",
    "color": "color",
    "image": "image",
    "logo": "logo",
    "tz_time_zone": "tz_time_zone",
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "time_restriction_enabled": true,
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 100,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ]
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "place": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "address": {
          "type": "string"
        },
        "color": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        },
        "time_zone: `time_zone`": {
          "type": "string"
        },
        "tz_time_zone": {
          "type": "string"
        },
        "primary_device_restriction_enabled": {
          "type": "boolean"
        },
        "reader_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_radius": {
          "type": "number"
        },
        "time_restriction_time_slots": {
          "type": "array"
        }
      },
      "required": [
        "name",
        "address"
      ]
    }
  },
  "required": [
    "place"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Dashboard

Dashboard.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "gateways_count": 0,
  "gateways_offline_count": 0,
  "locks_count": 0,
  "locks_not_online_count": 0,
  "locks_unconfigured_count": 0,
  "groups_count": 0,
  "members_count": 0,
  "integrations_count": 0,
  "integrations_disabled_count": 0,
  "status": "0",
  "status_message": "status"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "gateways_count": {
      "type": "number"
    },
    "gateways_offline_count": {
      "type": "number"
    },
    "locks_count": {
      "type": "number"
    },
    "locks_not_online_count": {
      "type": "number"
    },
    "locks_unconfigured_count": {
      "type": "number"
    },
    "groups_count": {
      "type": "number"
    },
    "members_count": {
      "type": "number"
    },
    "integrations_count": {
      "type": "number"
    },
    "integrations_disabled_count": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "status_message": {
      "type": "string"
    }
  },
  "required": [
    "gateways_count",
    "gateways_offline_count",
    "locks_count",
    "locks_not_online_count",
    "locks_unconfigured_count",
    "groups_count",
    "members_count",
    "integrations_count",
    "integrations_disabled_count",
    "status",
    "status_message"
  ]
}
                      

Request Transfer

Request transfer.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "place": {
    "transfer_to_id": 0,
    "transfer_to_email": "name@company.domain"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "place": {
      "type": "object",
      "properties": {
        "transfer_to_id": {
          "type": "number"
        },
        "transfer_to_email": {
          "type": "string"
        }
      },
      "required": [
        "transfer_to_email"
      ]
    }
  },
  "required": [
    "place"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Cancel Transfer

Cancel transfer.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Accept Transfer

Accept transfer.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Reject Transfer

Reject transfer.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Groups

Groups.

Groups Collection

Index

Index.

REQUEST

Parameters
query string query -
lock_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "description": "description",
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 100,
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "time_restriction_enabled": true,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ],
    "members_count": 0,
    "locks_count": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "place_id": 0,
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "group": {
    "name": "name",
    "description": "description",
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 100,
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "time_restriction_enabled": true,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ],
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "geofence_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_radius": {
          "type": "number"
        },
        "primary_device_restriction_enabled": {
          "type": "boolean"
        },
        "reader_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_time_zone: `time_restriction_time_zone`": {
          "type": "string"
        },
        "time_restriction_time_slots": {
          "type": "array"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "name",
        "place_id"
      ]
    }
  },
  "required": [
    "group"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "description": "description",
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 100,
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "time_restriction_enabled": true,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "members_count": 0,
  "locks_count": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_time_zone: `time_restriction_time_zone`": {
      "type": "string"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "members_count": {
      "type": "number"
    },
    "locks_count": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "created_at",
    "updated_at",
    "place_id",
    "place"
  ]
}
                      
Groups Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "description": "description",
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 100,
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "time_restriction_enabled": true,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "members_count": 0,
  "locks_count": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_time_zone: `time_restriction_time_zone`": {
      "type": "string"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "members_count": {
      "type": "number"
    },
    "locks_count": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "created_at",
    "updated_at",
    "place_id",
    "place"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "group": {
    "name": "name",
    "description": "description",
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 100,
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "time_restriction_enabled": true,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ]
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "geofence_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_radius": {
          "type": "number"
        },
        "primary_device_restriction_enabled": {
          "type": "boolean"
        },
        "reader_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_time_zone: `time_restriction_time_zone`": {
          "type": "string"
        },
        "time_restriction_time_slots": {
          "type": "array"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "group"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Locks

Locks.

Locks Collection

Index

Index.

REQUEST

Parameters
query string query -
online boolean true -
configured boolean true -
place_id number 0 -
not_in_group_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret> || KISI-LINK token=<LINK TOKEN>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "name": "name",
    "description": "description",
    "latitude": 0,
    "longitude": 0,
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 0,
    "time_restriction_enabled": true,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ],
    "time_restriction_time_zone": "time zone",
    "order_id": "0000-01-01T00:00:00+00:00",
    "gateway_id": 0,
    "place_id": 0,
    "id": 0,
    "configured": true,
    "online": true,
    "unlocked": true,
    "unlocked_until": "0000-01-01T00:00:00+00:00",
    "locked_down": false,
    "locked_down_since": "0000-01-01T00:00:00+00:00",
    "schedules": [
      {
        "starts_at": "0000-01-01T00:00:00+00:00",
        "ends_at": "0000-01-01T00:00:00+00:00"
      }
    ],
    "open": true,
    "last_opened_at": "0000-01-01T00:00:00+00:00",
    "last_closed_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "beacons": [
      {
        "id": 0,
        "enabled": true,
        "tap_enabled": true,
        "notification_enabled": true,
        "transmission": "BLE",
        "uuid": "uuid",
        "major": 0,
        "minor": 0,
        "lock_id": 0
      }
    ],
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "lock": {
    "name": "name",
    "description": "description",
    "latitude": 0,
    "longitude": 0,
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 0,
    "time_restriction_enabled": true,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ],
    "time_restriction_time_zone": "time zone",
    "order_id": "0000-01-01T00:00:00+00:00",
    "gateway_id": 0,
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "lock": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "primary_device_restriction_enabled": {
          "type": "boolean"
        },
        "reader_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_radius": {
          "type": "number"
        },
        "time_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_time_slots": {
          "type": "array"
        },
        "time_restriction_time_zone": {
          "type": "string"
        },
        "order_id": {
          "type": "string"
        },
        "gateway_id": {
          "type": "number"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "name",
        "description",
        "place_id"
      ]
    }
  },
  "required": [
    "lock"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "description": "description",
  "latitude": 0,
  "longitude": 0,
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 0,
  "time_restriction_enabled": true,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "time_restriction_time_zone": "time zone",
  "order_id": "0000-01-01T00:00:00+00:00",
  "gateway_id": 0,
  "place_id": 0,
  "id": 0,
  "configured": true,
  "online": true,
  "unlocked": true,
  "unlocked_until": "0000-01-01T00:00:00+00:00",
  "locked_down": false,
  "locked_down_since": "0000-01-01T00:00:00+00:00",
  "schedules": [
    {
      "starts_at": "0000-01-01T00:00:00+00:00",
      "ends_at": "0000-01-01T00:00:00+00:00"
    }
  ],
  "open": true,
  "last_opened_at": "0000-01-01T00:00:00+00:00",
  "last_closed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "beacons": [
    {
      "id": 0,
      "enabled": true,
      "tap_enabled": true,
      "notification_enabled": true,
      "transmission": "BLE",
      "uuid": "uuid",
      "major": 0,
      "minor": 0,
      "lock_id": 0
    }
  ],
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "time_restriction_time_zone": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "gateway_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "configured": {
      "type": "boolean"
    },
    "online": {
      "type": "boolean"
    },
    "unlocked": {
      "type": "boolean"
    },
    "unlocked_until": {
      "type": "string"
    },
    "locked_down": {
      "type": "boolean"
    },
    "locked_down_since": {
      "type": "string"
    },
    "schedules": {
      "type": "array"
    },
    "open": {
      "type": "boolean"
    },
    "last_opened_at": {
      "type": "string"
    },
    "last_closed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "beacons": {
      "type": "array"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "name",
    "description",
    "place_id",
    "id",
    "configured",
    "online",
    "unlocked",
    "unlocked_until",
    "locked_down",
    "locked_down_since",
    "last_opened_at",
    "last_closed_at",
    "created_at",
    "updated_at",
    "beacons"
  ]
}
                      
Locks Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "description": "description",
  "latitude": 0,
  "longitude": 0,
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 0,
  "time_restriction_enabled": true,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "time_restriction_time_zone": "time zone",
  "order_id": "0000-01-01T00:00:00+00:00",
  "gateway_id": 0,
  "place_id": 0,
  "id": 0,
  "configured": true,
  "online": true,
  "unlocked": true,
  "unlocked_until": "0000-01-01T00:00:00+00:00",
  "locked_down": false,
  "locked_down_since": "0000-01-01T00:00:00+00:00",
  "schedules": [
    {
      "starts_at": "0000-01-01T00:00:00+00:00",
      "ends_at": "0000-01-01T00:00:00+00:00"
    }
  ],
  "open": true,
  "last_opened_at": "0000-01-01T00:00:00+00:00",
  "last_closed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "beacons": [
    {
      "id": 0,
      "enabled": true,
      "tap_enabled": true,
      "notification_enabled": true,
      "transmission": "BLE",
      "uuid": "uuid",
      "major": 0,
      "minor": 0,
      "lock_id": 0
    }
  ],
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "time_restriction_time_zone": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "gateway_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "configured": {
      "type": "boolean"
    },
    "online": {
      "type": "boolean"
    },
    "unlocked": {
      "type": "boolean"
    },
    "unlocked_until": {
      "type": "string"
    },
    "locked_down": {
      "type": "boolean"
    },
    "locked_down_since": {
      "type": "string"
    },
    "schedules": {
      "type": "array"
    },
    "open": {
      "type": "boolean"
    },
    "last_opened_at": {
      "type": "string"
    },
    "last_closed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "beacons": {
      "type": "array"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "name",
    "description",
    "place_id",
    "id",
    "configured",
    "online",
    "unlocked",
    "unlocked_until",
    "locked_down",
    "locked_down_since",
    "last_opened_at",
    "last_closed_at",
    "created_at",
    "updated_at",
    "beacons"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "lock": {
    "name": "name",
    "description": "description",
    "latitude": 0,
    "longitude": 0,
    "primary_device_restriction_enabled": true,
    "reader_restriction_enabled": true,
    "geofence_restriction_enabled": true,
    "geofence_restriction_radius": 0,
    "time_restriction_enabled": true,
    "time_restriction_time_slots": [
      {
        "weekday": 0,
        "allowed_from": 0,
        "allowed_until": 0
      }
    ],
    "time_restriction_time_zone": "time zone",
    "order_id": "0000-01-01T00:00:00+00:00",
    "gateway_id": 0,
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "lock": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "primary_device_restriction_enabled": {
          "type": "boolean"
        },
        "reader_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_enabled": {
          "type": "boolean"
        },
        "geofence_restriction_radius": {
          "type": "number"
        },
        "time_restriction_enabled": {
          "type": "boolean"
        },
        "time_restriction_time_slots": {
          "type": "array"
        },
        "time_restriction_time_zone": {
          "type": "string"
        },
        "order_id": {
          "type": "string"
        },
        "gateway_id": {
          "type": "number"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "name",
        "description",
        "place_id"
      ]
    }
  },
  "required": [
    "lock"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Unlock

Unlock.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret> || KISI-LINK <LINK TOKEN>
application/json
                          {
  "trigger": "presence | notification | widget | app",
  "context": {
    "app": {
      "uuid": "uuid",
      "version": "version"
    },
    "beacons": [
      {
        "uuid": "uuid",
        "major": 12,
        "minor": 12,
        "rssi": 12,
        "accuracy": 2,
        "age": 10000
      }
    ],
    "device": {
      "ip": "192.168.1.1",
      "mac": "mac",
      "manufacturer": "manufacturer",
      "model": "model"
    },
    "location": {
      "latitude": 59.333,
      "longitude": 18.062118,
      "altitude": 14,
      "age": 10000,
      "horizontal_accuracy": 10,
      "vertical_accuracy": 10
    },
    "os": {
      "name": "name",
      "rooted": false,
      "version": "7.0"
    },
    "services": [
      {
        "type": "type",
        "available": false,
        "authorized": false,
        "enabled": false
      }
    ],
    "wifi": {
      "bssid": "bssid",
      "open": true,
      "ssid": "ssid",
      "rssi": 23
    },
    "wifis": [
      {
        "bssid": "bssid",
        "open": true,
        "ssid": "ssid",
        "rssi": 23
      }
    ]
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trigger": {
      "type": "string"
    },
    "context": {
      "type": "object",
      "properties": {
        "app": {
          "type": "object",
          "properties": {
            "uuid": {
              "type": "string"
            },
            "version": {
              "type": "string"
            }
          }
        },
        "beacons": {
          "type": "array"
        },
        "device": {
          "type": "object",
          "properties": {
            "ip": {
              "type": "string"
            },
            "mac": {
              "type": "string"
            },
            "manufacturer": {
              "type": "string"
            },
            "model": {
              "type": "string"
            }
          }
        },
        "location": {
          "type": "object",
          "properties": {
            "latitude": {
              "type": "number"
            },
            "longitude": {
              "type": "number"
            },
            "altitude": {
              "type": "number"
            },
            "age": {
              "type": "number"
            },
            "horizontal_accuracy": {
              "type": "number"
            },
            "vertical_accuracy": {
              "type": "number"
            }
          }
        },
        "os": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "rooted": {
              "type": "boolean"
            },
            "version": {
              "type": "string"
            }
          }
        },
        "services": {
          "type": "array"
        },
        "wifi": {
          "type": "object",
          "properties": {
            "bssid": {
              "type": "string"
            },
            "open": {
              "type": "boolean"
            },
            "ssid": {
              "type": "string"
            },
            "rssi": {
              "type": "number"
            }
          }
        },
        "wifis": {
          "type": "array"
        }
      }
    }
  }
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "name",
  "description": "description",
  "latitude": 0,
  "longitude": 0,
  "primary_device_restriction_enabled": true,
  "reader_restriction_enabled": true,
  "geofence_restriction_enabled": true,
  "geofence_restriction_radius": 0,
  "time_restriction_enabled": true,
  "time_restriction_time_slots": [
    {
      "weekday": 0,
      "allowed_from": 0,
      "allowed_until": 0
    }
  ],
  "time_restriction_time_zone": "time zone",
  "order_id": "0000-01-01T00:00:00+00:00",
  "gateway_id": 0,
  "place_id": 0,
  "id": 0,
  "configured": true,
  "online": true,
  "unlocked": true,
  "unlocked_until": "0000-01-01T00:00:00+00:00",
  "locked_down": false,
  "locked_down_since": "0000-01-01T00:00:00+00:00",
  "schedules": [
    {
      "starts_at": "0000-01-01T00:00:00+00:00",
      "ends_at": "0000-01-01T00:00:00+00:00"
    }
  ],
  "open": true,
  "last_opened_at": "0000-01-01T00:00:00+00:00",
  "last_closed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "beacons": [
    {
      "id": 0,
      "enabled": true,
      "tap_enabled": true,
      "notification_enabled": true,
      "transmission": "BLE",
      "uuid": "uuid",
      "major": 0,
      "minor": 0,
      "lock_id": 0
    }
  ],
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "primary_device_restriction_enabled": {
      "type": "boolean"
    },
    "reader_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_enabled": {
      "type": "boolean"
    },
    "geofence_restriction_radius": {
      "type": "number"
    },
    "time_restriction_enabled": {
      "type": "boolean"
    },
    "time_restriction_time_slots": {
      "type": "array"
    },
    "time_restriction_time_zone": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "gateway_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "configured": {
      "type": "boolean"
    },
    "online": {
      "type": "boolean"
    },
    "unlocked": {
      "type": "boolean"
    },
    "unlocked_until": {
      "type": "string"
    },
    "locked_down": {
      "type": "boolean"
    },
    "locked_down_since": {
      "type": "string"
    },
    "schedules": {
      "type": "array"
    },
    "open": {
      "type": "boolean"
    },
    "last_opened_at": {
      "type": "string"
    },
    "last_closed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "beacons": {
      "type": "array"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "name",
    "description",
    "place_id",
    "id",
    "configured",
    "online",
    "unlocked",
    "unlocked_until",
    "locked_down",
    "locked_down_since",
    "last_opened_at",
    "last_closed_at",
    "created_at",
    "updated_at",
    "beacons"
  ]
}
                      

Lock down

Lock down.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Authorization KISI-LOGIN <secret> || KISI-LINK <LINK TOKEN>

RESPONSE

Headers
Content-Type application/json

Cancel Lockdown

Cancel lockdown.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Authorization KISI-LOGIN <secret> || KISI-LINK <LINK TOKEN>

RESPONSE

Headers
Content-Type application/json

Peek

Peek.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
GroupLocks

Group locks.

GroupLocks Collection

Index

Index.

REQUEST

Parameters
group_id number 0 -
lock_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "group_id": 0,
    "lock_id": 0,
    "place_id": 0,
    "id": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "group": {
      "id": 0,
      "name": "name"
    },
    "lock": {
      "id": 0,
      "name": "name"
    },
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "group_lock": {
    "group_id": 0,
    "lock_id": 0,
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_lock": {
      "type": "object",
      "properties": {
        "group_id": {
          "type": "number"
        },
        "lock_id": {
          "type": "number"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "group_id",
        "lock_id",
        "place_id"
      ]
    }
  },
  "required": [
    "group_lock"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "group_id": 0,
  "lock_id": 0,
  "place_id": 0,
  "id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "group": {
    "id": 0,
    "name": "name"
  },
  "lock": {
    "id": 0,
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_id": {
      "type": "number"
    },
    "lock_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "group": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "group_id",
    "lock_id",
    "place_id",
    "id",
    "created_at",
    "updated_at",
    "group",
    "lock",
    "place"
  ]
}
                      
GroupLocks Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "group_id": 0,
  "lock_id": 0,
  "place_id": 0,
  "id": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "group": {
    "id": 0,
    "name": "name"
  },
  "lock": {
    "id": 0,
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_id": {
      "type": "number"
    },
    "lock_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "group": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "group_id",
    "lock_id",
    "place_id",
    "id",
    "created_at",
    "updated_at",
    "group",
    "lock",
    "place"
  ]
}
                      

Destroy

Destroy.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Schedules

Schedules are a simplified representation of calendar events and may be used to configure time based functionality:

  • When locks are kept unlocked (“unlock timer”), set consequence to unlock

  • When access is allowed or restricted (“time restrictions”), set consequence to allow

There are three types of schedules:

  • Single event: an event that starts and ends on specific date times regardless of time zone

  • Single all day event: events that are interpreted based on the time zone of the place they’re added to

  • Recurring event: events that are interpreted based on the current weekday based on the time zone of the place they are added to

The API makes a few assumptions:

  • If starts_at or ends_at are set, events are treated as single events

  • If starts_at_date or ends_at_date are set, events are treated as single all day events

  • Else, events are treated as recurring events

Validations:

  • Single events require both starts_at and ends_at as RFC3339 timestamps

  • Single all day events require both starts_at_date and ends_at_date in the YYYY-MM-DD format

  • Recurring events require at least one weekday, and may specify starts_at_time and ends_at_time in the hh:mm format

  • Starting dates/times must be before ending dates/times

The difference between single events and all day events are that single events are absolute, i.e. independent of the time zone of the place. Single all day events carry no time zone information but are always interpreted based on the time zone of the place.

Schedules Collection

Index

Index.

REQUEST

Parameters
scheduleable_type string type

allowed values: Lock, Group, Place

scheduleable_id number 0 -
consequence string allow

allowed values: allow, unlock

Headers
Content-Type application/json
application/json
                              Accept: application/json
    Authorization: KISI-LOGIN <secret>

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "type": "single_event",
    "enabled": true,
    "consequence": "allow",
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "place_id": 0,
    "integration_id": 0,
    "scheduleable_type": "type",
    "scheduleable_id": 0,
    "next_occurence": {
      "starts_at": "0000-01-01T00:00:00+00:00",
      "ends_at": "0000-01-01T00:00:00+00:00"
    },
    "place": {
      "id": 0,
      "name": "name"
    },
    "integration": {
      "id": 0,
      "name": "name"
    },
    "scheduleable": {
      "id": 0,
      "type": "type",
      "name": "name"
    }
  },
  {
    "id": 0,
    "type": "single_all_day_event",
    "consequence": "allow",
    "starts_at_date": "0000-01-01",
    "ends_at_date": "0000-01-01",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "place_id": 0,
    "integration_id": 0,
    "scheduleable_type": "type",
    "scheduleable_id": 0,
    "next_occurence": {
      "starts_at": "0000-01-01T00:00:00+00:00",
      "ends_at": "0000-01-01T00:00:00+00:00"
    },
    "place": {
      "id": 0,
      "name": "name"
    },
    "integration": {
      "id": 0,
      "name": "name"
    },
    "scheduleable": {
      "id": 0,
      "type": "type",
      "name": "name"
    }
  },
  {
    "id": 0,
    "type": "recurring_event",
    "consequence": "allow",
    "starts_at_time": "00:00",
    "ends_at_time": "00:00",
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "place_id": 0,
    "integration_id": 0,
    "scheduleable_type": "type",
    "scheduleable_id": 0,
    "next_occurence": {
      "starts_at": "0000-01-01T00:00:00+00:00",
      "ends_at": "0000-01-01T00:00:00+00:00"
    },
    "place": {
      "id": 0,
      "name": "name"
    },
    "integration": {
      "id": 0,
      "name": "name"
    },
    "scheduleable": {
      "id": 0,
      "type": "type",
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create Single Event

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "schedule": {
    "type": "single_event",
    "enabled": true,
    "consequence": "allow",
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "consequence": {
          "type": "string"
        },
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "consequence"
      ]
    }
  },
  "required": [
    "schedule"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "single_event",
  "enabled": true,
  "consequence": "allow",
  "starts_at": "0000-01-01T00:00:00+00:00",
  "ends_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "integration_id": 0,
  "scheduleable_type": "type",
  "scheduleable_id": 0,
  "next_occurence": {
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  },
  "place": {
    "id": 0,
    "name": "name"
  },
  "integration": {
    "id": 0,
    "name": "name"
  },
  "scheduleable": {
    "id": 0,
    "type": "type",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "consequence": {
      "type": "string"
    },
    "starts_at": {
      "type": "string"
    },
    "ends_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "integration_id": {
      "type": "number"
    },
    "scheduleable_type": {
      "type": "string"
    },
    "scheduleable_id": {
      "type": "number"
    },
    "next_occurence": {
      "type": "object",
      "properties": {
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "starts_at",
        "ends_at"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "integration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "scheduleable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "enabled",
    "consequence",
    "created_at",
    "updated_at",
    "place_id",
    "integration_id",
    "scheduleable_type",
    "scheduleable_id",
    "place",
    "scheduleable"
  ]
}
                      

Create Single All Day Event

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "schedule": {
    "type": "single_all_day_event",
    "enabled": true,
    "consequence": "allow",
    "starts_at_date": "0000-01-01",
    "ends_at_date": "0000-01-01"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "consequence": {
          "type": "string"
        },
        "starts_at_date": {
          "type": "string"
        },
        "ends_at_date": {
          "type": "string"
        }
      },
      "required": [
        "consequence"
      ]
    }
  },
  "required": [
    "schedule"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "single_all_day_event",
  "consequence": "allow",
  "starts_at_date": "0000-01-01",
  "ends_at_date": "0000-01-01",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "integration_id": 0,
  "scheduleable_type": "type",
  "scheduleable_id": 0,
  "next_occurence": {
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  },
  "place": {
    "id": 0,
    "name": "name"
  },
  "integration": {
    "id": 0,
    "name": "name"
  },
  "scheduleable": {
    "id": 0,
    "type": "type",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "consequence": {
      "type": "string"
    },
    "starts_at_date": {
      "type": "string"
    },
    "ends_at_date": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "integration_id": {
      "type": "number"
    },
    "scheduleable_type": {
      "type": "string"
    },
    "scheduleable_id": {
      "type": "number"
    },
    "next_occurence": {
      "type": "object",
      "properties": {
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "starts_at",
        "ends_at"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "integration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "scheduleable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "consequence",
    "created_at",
    "updated_at",
    "place_id",
    "integration_id",
    "scheduleable_type",
    "scheduleable_id",
    "place",
    "scheduleable"
  ]
}
                      

Create Single Recurring Event

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "schedule": {
    "type": "recurring_event",
    "enabled": true,
    "consequence": "allow",
    "starts_at_time": "00:00",
    "ends_at_time": "00:00",
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "consequence": {
          "type": "string"
        },
        "starts_at_time": {
          "type": "string"
        },
        "ends_at_time": {
          "type": "string"
        },
        "monday": {
          "type": "boolean"
        },
        "tuesday": {
          "type": "boolean"
        },
        "wednesday": {
          "type": "boolean"
        },
        "thursday": {
          "type": "boolean"
        },
        "friday": {
          "type": "boolean"
        },
        "saturday": {
          "type": "boolean"
        },
        "sunday": {
          "type": "boolean"
        }
      },
      "required": [
        "consequence"
      ]
    }
  },
  "required": [
    "schedule"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "recurring_event",
  "consequence": "allow",
  "starts_at_time": "00:00",
  "ends_at_time": "00:00",
  "monday": true,
  "tuesday": true,
  "wednesday": true,
  "thursday": true,
  "friday": true,
  "saturday": true,
  "sunday": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "integration_id": 0,
  "scheduleable_type": "type",
  "scheduleable_id": 0,
  "next_occurence": {
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  },
  "place": {
    "id": 0,
    "name": "name"
  },
  "integration": {
    "id": 0,
    "name": "name"
  },
  "scheduleable": {
    "id": 0,
    "type": "type",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "consequence": {
      "type": "string"
    },
    "starts_at_time": {
      "type": "string"
    },
    "ends_at_time": {
      "type": "string"
    },
    "monday": {
      "type": "boolean"
    },
    "tuesday": {
      "type": "boolean"
    },
    "wednesday": {
      "type": "boolean"
    },
    "thursday": {
      "type": "boolean"
    },
    "friday": {
      "type": "boolean"
    },
    "saturday": {
      "type": "boolean"
    },
    "sunday": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "integration_id": {
      "type": "number"
    },
    "scheduleable_type": {
      "type": "string"
    },
    "scheduleable_id": {
      "type": "number"
    },
    "next_occurence": {
      "type": "object",
      "properties": {
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "starts_at",
        "ends_at"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "integration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "scheduleable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "consequence",
    "created_at",
    "updated_at",
    "place_id",
    "integration_id",
    "scheduleable_type",
    "scheduleable_id",
    "place",
    "scheduleable"
  ]
}
                      
Schedules Member

Show Single Event

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "single_event",
  "enabled": true,
  "consequence": "allow",
  "starts_at": "0000-01-01T00:00:00+00:00",
  "ends_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "integration_id": 0,
  "scheduleable_type": "type",
  "scheduleable_id": 0,
  "next_occurence": {
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  },
  "place": {
    "id": 0,
    "name": "name"
  },
  "integration": {
    "id": 0,
    "name": "name"
  },
  "scheduleable": {
    "id": 0,
    "type": "type",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "consequence": {
      "type": "string"
    },
    "starts_at": {
      "type": "string"
    },
    "ends_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "integration_id": {
      "type": "number"
    },
    "scheduleable_type": {
      "type": "string"
    },
    "scheduleable_id": {
      "type": "number"
    },
    "next_occurence": {
      "type": "object",
      "properties": {
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "starts_at",
        "ends_at"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "integration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "scheduleable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "enabled",
    "consequence",
    "created_at",
    "updated_at",
    "place_id",
    "integration_id",
    "scheduleable_type",
    "scheduleable_id",
    "place",
    "scheduleable"
  ]
}
                      

Show Single All Day Event

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "single_all_day_event",
  "consequence": "allow",
  "starts_at_date": "0000-01-01",
  "ends_at_date": "0000-01-01",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "integration_id": 0,
  "scheduleable_type": "type",
  "scheduleable_id": 0,
  "next_occurence": {
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  },
  "place": {
    "id": 0,
    "name": "name"
  },
  "integration": {
    "id": 0,
    "name": "name"
  },
  "scheduleable": {
    "id": 0,
    "type": "type",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "consequence": {
      "type": "string"
    },
    "starts_at_date": {
      "type": "string"
    },
    "ends_at_date": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "integration_id": {
      "type": "number"
    },
    "scheduleable_type": {
      "type": "string"
    },
    "scheduleable_id": {
      "type": "number"
    },
    "next_occurence": {
      "type": "object",
      "properties": {
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "starts_at",
        "ends_at"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "integration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "scheduleable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "consequence",
    "created_at",
    "updated_at",
    "place_id",
    "integration_id",
    "scheduleable_type",
    "scheduleable_id",
    "place",
    "scheduleable"
  ]
}
                      

Show Recurring Event

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "recurring_event",
  "consequence": "allow",
  "starts_at_time": "00:00",
  "ends_at_time": "00:00",
  "monday": true,
  "tuesday": true,
  "wednesday": true,
  "thursday": true,
  "friday": true,
  "saturday": true,
  "sunday": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "integration_id": 0,
  "scheduleable_type": "type",
  "scheduleable_id": 0,
  "next_occurence": {
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  },
  "place": {
    "id": 0,
    "name": "name"
  },
  "integration": {
    "id": 0,
    "name": "name"
  },
  "scheduleable": {
    "id": 0,
    "type": "type",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "consequence": {
      "type": "string"
    },
    "starts_at_time": {
      "type": "string"
    },
    "ends_at_time": {
      "type": "string"
    },
    "monday": {
      "type": "boolean"
    },
    "tuesday": {
      "type": "boolean"
    },
    "wednesday": {
      "type": "boolean"
    },
    "thursday": {
      "type": "boolean"
    },
    "friday": {
      "type": "boolean"
    },
    "saturday": {
      "type": "boolean"
    },
    "sunday": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "integration_id": {
      "type": "number"
    },
    "scheduleable_type": {
      "type": "string"
    },
    "scheduleable_id": {
      "type": "number"
    },
    "next_occurence": {
      "type": "object",
      "properties": {
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      },
      "required": [
        "starts_at",
        "ends_at"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "integration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "scheduleable": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "consequence",
    "created_at",
    "updated_at",
    "place_id",
    "integration_id",
    "scheduleable_type",
    "scheduleable_id",
    "place",
    "scheduleable"
  ]
}
                      

Update Single Event

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "schedule": {
    "enabled": true,
    "starts_at": "0000-01-01T00:00:00+00:00",
    "ends_at": "0000-01-01T00:00:00+00:00"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "schedule"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Update Single All Day Event

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "schedule": {
    "enabled": true,
    "starts_at_date": "0000-01-01",
    "ends_at_date": "0000-01-01"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "starts_at_date": {
          "type": "string"
        },
        "ends_at_date": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "schedule"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Update Recurring Event

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "schedule": {
    "enabled": true,
    "starts_at_time": "00:00",
    "ends_at_time": "00:00",
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "starts_at_time": {
          "type": "string"
        },
        "ends_at_time": {
          "type": "string"
        },
        "monday": {
          "type": "boolean"
        },
        "tuesday": {
          "type": "boolean"
        },
        "wednesday": {
          "type": "boolean"
        },
        "thursday": {
          "type": "boolean"
        },
        "friday": {
          "type": "boolean"
        },
        "saturday": {
          "type": "boolean"
        },
        "sunday": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "schedule"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Members

Members.

Members Collection

Index

Index.

REQUEST

Parameters
query string query -
confirmed boolean true -
user_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "confirmed": true,
    "link_enabled": true,
    "link_last_used_at": "0000-01-01T00:00:00+00:00",
    "login_enabled": true,
    "login_last_used_at": "0000-01-01T00:00:00+00:00",
    "card_assigned": true,
    "card_assigned_at": "0000-01-01T00:00:00+00:00",
    "backup_card_assigned": true,
    "backup_card_assigned_at": "0000-01-01T00:00:00+00:00",
    "cards_count": 0,
    "shares_count": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "card_id": 0,
    "backup_card_id": 0,
    "card_assigned_by_id": 0,
    "backup_card_assigned_by_id": 0,
    "user_id": 0,
    "place_id": 0,
    "card": {
      "id": 0,
      "token": "token",
      "activated": true,
      "last_used_at": "0000-01-01T00:00:00+00:00"
    },
    "backup_card": {
      "id": 0,
      "token": "token",
      "activated": true,
      "last_used_at": "0000-01-01T00:00:00+00:00"
    },
    "card_assigned_by": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "backup_card_assigned_by": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "user": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "member": {
    "name": "name",
    "image": "image",
    "card_enabled": true,
    "backup_card_enabled": true,
    "link_enabled": true,
    "login_enabled": true,
    "place_id": 0,
    "user_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "card_enabled": {
          "type": "boolean"
        },
        "backup_card_enabled": {
          "type": "boolean"
        },
        "link_enabled": {
          "type": "boolean"
        },
        "login_enabled": {
          "type": "boolean"
        },
        "place_id": {
          "type": "number"
        },
        "user_id": {
          "type": "number"
        }
      },
      "required": [
        "name",
        "image",
        "card_enabled",
        "backup_card_enabled",
        "link_enabled",
        "login_enabled",
        "place_id",
        "user_id"
      ]
    }
  },
  "required": [
    "member"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "confirmed": true,
  "link_enabled": true,
  "link_last_used_at": "0000-01-01T00:00:00+00:00",
  "login_enabled": true,
  "login_last_used_at": "0000-01-01T00:00:00+00:00",
  "card_assigned": true,
  "card_assigned_at": "0000-01-01T00:00:00+00:00",
  "backup_card_assigned": true,
  "backup_card_assigned_at": "0000-01-01T00:00:00+00:00",
  "cards_count": 0,
  "shares_count": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "card_id": 0,
  "backup_card_id": 0,
  "card_assigned_by_id": 0,
  "backup_card_assigned_by_id": 0,
  "user_id": 0,
  "place_id": 0,
  "card": {
    "id": 0,
    "token": "token",
    "activated": true,
    "last_used_at": "0000-01-01T00:00:00+00:00"
  },
  "backup_card": {
    "id": 0,
    "token": "token",
    "activated": true,
    "last_used_at": "0000-01-01T00:00:00+00:00"
  },
  "card_assigned_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "backup_card_assigned_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "confirmed": {
      "type": "boolean"
    },
    "link_enabled": {
      "type": "boolean"
    },
    "link_last_used_at": {
      "type": "string"
    },
    "login_enabled": {
      "type": "boolean"
    },
    "login_last_used_at": {
      "type": "string"
    },
    "card_assigned": {
      "type": "boolean"
    },
    "card_assigned_at": {
      "type": "string"
    },
    "backup_card_assigned": {
      "type": "boolean"
    },
    "backup_card_assigned_at": {
      "type": "string"
    },
    "cards_count": {
      "type": "number"
    },
    "shares_count": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "card_id": {
      "type": "number"
    },
    "backup_card_id": {
      "type": "number"
    },
    "card_assigned_by_id": {
      "type": "number"
    },
    "backup_card_assigned_by_id": {
      "type": "number"
    },
    "user_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "card": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "token": {
          "type": "string"
        },
        "activated": {
          "type": "boolean"
        },
        "last_used_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "token",
        "activated",
        "last_used_at"
      ]
    },
    "backup_card": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "token": {
          "type": "string"
        },
        "activated": {
          "type": "boolean"
        },
        "last_used_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "token",
        "activated",
        "last_used_at"
      ]
    },
    "card_assigned_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "backup_card_assigned_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "confirmed",
    "link_enabled",
    "link_last_used_at",
    "login_enabled",
    "login_last_used_at",
    "card_assigned",
    "card_assigned_at",
    "card_assigned_by_id",
    "backup_card_assigned",
    "backup_card_id",
    "backup_card_assigned_at",
    "backup_card_assigned_by_id",
    "cards_count",
    "shares_count",
    "created_at",
    "updated_at",
    "card_id",
    "backup_card_id",
    "card_assigned_by_id",
    "backup_card_assigned_by_id",
    "user_id",
    "place_id",
    "card",
    "backup_card",
    "card_assigned_by",
    "backup_card_assigned_by",
    "user",
    "place"
  ]
}
                      
Members Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "confirmed": true,
  "link_enabled": true,
  "link_last_used_at": "0000-01-01T00:00:00+00:00",
  "login_enabled": true,
  "login_last_used_at": "0000-01-01T00:00:00+00:00",
  "card_assigned": true,
  "card_assigned_at": "0000-01-01T00:00:00+00:00",
  "backup_card_assigned": true,
  "backup_card_assigned_at": "0000-01-01T00:00:00+00:00",
  "cards_count": 0,
  "shares_count": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "card_id": 0,
  "backup_card_id": 0,
  "card_assigned_by_id": 0,
  "backup_card_assigned_by_id": 0,
  "user_id": 0,
  "place_id": 0,
  "card": {
    "id": 0,
    "token": "token",
    "activated": true,
    "last_used_at": "0000-01-01T00:00:00+00:00"
  },
  "backup_card": {
    "id": 0,
    "token": "token",
    "activated": true,
    "last_used_at": "0000-01-01T00:00:00+00:00"
  },
  "card_assigned_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "backup_card_assigned_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "confirmed": {
      "type": "boolean"
    },
    "link_enabled": {
      "type": "boolean"
    },
    "link_last_used_at": {
      "type": "string"
    },
    "login_enabled": {
      "type": "boolean"
    },
    "login_last_used_at": {
      "type": "string"
    },
    "card_assigned": {
      "type": "boolean"
    },
    "card_assigned_at": {
      "type": "string"
    },
    "backup_card_assigned": {
      "type": "boolean"
    },
    "backup_card_assigned_at": {
      "type": "string"
    },
    "cards_count": {
      "type": "number"
    },
    "shares_count": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "card_id": {
      "type": "number"
    },
    "backup_card_id": {
      "type": "number"
    },
    "card_assigned_by_id": {
      "type": "number"
    },
    "backup_card_assigned_by_id": {
      "type": "number"
    },
    "user_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "card": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "token": {
          "type": "string"
        },
        "activated": {
          "type": "boolean"
        },
        "last_used_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "token",
        "activated",
        "last_used_at"
      ]
    },
    "backup_card": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "token": {
          "type": "string"
        },
        "activated": {
          "type": "boolean"
        },
        "last_used_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "token",
        "activated",
        "last_used_at"
      ]
    },
    "card_assigned_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "backup_card_assigned_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "confirmed",
    "link_enabled",
    "link_last_used_at",
    "login_enabled",
    "login_last_used_at",
    "card_assigned",
    "card_assigned_at",
    "card_assigned_by_id",
    "backup_card_assigned",
    "backup_card_id",
    "backup_card_assigned_at",
    "backup_card_assigned_by_id",
    "cards_count",
    "shares_count",
    "created_at",
    "updated_at",
    "card_id",
    "backup_card_id",
    "card_assigned_by_id",
    "backup_card_assigned_by_id",
    "user_id",
    "place_id",
    "card",
    "backup_card",
    "card_assigned_by",
    "backup_card_assigned_by",
    "user",
    "place"
  ]
}
                      

Update

Updates a member by id.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "member": {
    "name": "name",
    "image": "image",
    "card_enabled": true,
    "backup_card_enabled": true,
    "link_enabled": true,
    "login_enabled": true
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "card_enabled": {
          "type": "boolean"
        },
        "backup_card_enabled": {
          "type": "boolean"
        },
        "link_enabled": {
          "type": "boolean"
        },
        "login_enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "image",
        "card_enabled",
        "backup_card_enabled",
        "link_enabled",
        "login_enabled"
      ]
    }
  },
  "required": [
    "member"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Deletes a member by id.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Assign Card

Assign backup card.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "member": {
    "card_id": 0,
    "card_token: `card_token`": ""
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "card_id": {
          "type": "number"
        },
        "card_token: `card_token`": {
          "type": "string"
        }
      },
      "required": [
        "card_id",
        "card_token: `card_token`"
      ]
    }
  },
  "required": [
    "member"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Assign Backup Card

Assign backup card.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "member": {
    "backup_card_id": 0,
    "backup_card_token": "backup_card_token"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "backup_card_id": {
          "type": "number"
        },
        "backup_card_token": {
          "type": "string"
        }
      },
      "required": [
        "backup_card_id",
        "backup_card_token"
      ]
    }
  },
  "required": [
    "member"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Deassign Card

Deassign card.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Deassign Backup Card

Deassign backup card.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Enable Card

Enable card.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Enable Backup Card

Enable backup card.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Shares

Shares.

Shares Collection

Index

Index.

REQUEST

Parameters
role string role -
card_enabled boolean true -
link_enabled boolean true -
login_enabled boolean true -
apply_to_place boolean true -
member_id number 0 -
user_id number 0 -
group_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
application/json
                              Accept: application/json
    Authorization: KISI-LOGIN <secret>

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "email": "name@company.domain",
    "role": "null",
    "card_enabled": false,
    "link_enabled": false,
    "login_enabled": false,
    "apply_to_place": false,
    "valid_from": "0000-01-01T00:00:00+00:00",
    "valid_until": "0000-01-01T00:00:00+00:00",
    "notify": true,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "user_id": 0,
    "issued_by_id": 0,
    "member_id": 0,
    "group_id": 0,
    "place_id": 0,
    "user": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "issued_by": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "member": {
      "id": 0,
      "name": "name",
      "card_enabled": false,
      "link_enabled": false,
      "login_enabled": false
    },
    "group": {
      "id": 0,
      "name": "name"
    },
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "share": {
    "email": "name@company.domain",
    "role": "null",
    "card_enabled": false,
    "link_enabled": false,
    "login_enabled": false,
    "apply_to_place": false,
    "valid_from": "0000-01-01T00:00:00+00:00",
    "valid_until": "0000-01-01T00:00:00+00:00",
    "notify": true,
    "group_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "share": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "card_enabled": {
          "type": "boolean"
        },
        "link_enabled": {
          "type": "boolean"
        },
        "login_enabled": {
          "type": "boolean"
        },
        "apply_to_place": {
          "type": "boolean"
        },
        "valid_from": {
          "type": "string"
        },
        "valid_until": {
          "type": "string"
        },
        "notify": {
          "type": "boolean"
        },
        "group_id": {
          "type": "number"
        }
      },
      "required": [
        "email",
        "group_id"
      ]
    }
  },
  "required": [
    "share"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "email": "name@company.domain",
  "role": "null",
  "card_enabled": false,
  "link_enabled": false,
  "login_enabled": false,
  "apply_to_place": false,
  "valid_from": "0000-01-01T00:00:00+00:00",
  "valid_until": "0000-01-01T00:00:00+00:00",
  "notify": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "issued_by_id": 0,
  "member_id": 0,
  "group_id": 0,
  "place_id": 0,
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "issued_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "member": {
    "id": 0,
    "name": "name",
    "card_enabled": false,
    "link_enabled": false,
    "login_enabled": false
  },
  "group": {
    "id": 0,
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "card_enabled": {
      "type": "boolean"
    },
    "link_enabled": {
      "type": "boolean"
    },
    "login_enabled": {
      "type": "boolean"
    },
    "apply_to_place": {
      "type": "boolean"
    },
    "valid_from": {
      "type": "string"
    },
    "valid_until": {
      "type": "string"
    },
    "notify": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "issued_by_id": {
      "type": "number"
    },
    "member_id": {
      "type": "number"
    },
    "group_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "issued_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "member": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "card_enabled": {
          "type": "boolean"
        },
        "link_enabled": {
          "type": "boolean"
        },
        "login_enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "group": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "email",
    "created_at",
    "updated_at",
    "user_id",
    "issued_by_id",
    "member_id",
    "group_id",
    "place_id",
    "user",
    "issued_by",
    "member",
    "group",
    "place"
  ]
}
                      
Shares Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "email": "name@company.domain",
  "role": "null",
  "card_enabled": false,
  "link_enabled": false,
  "login_enabled": false,
  "apply_to_place": false,
  "valid_from": "0000-01-01T00:00:00+00:00",
  "valid_until": "0000-01-01T00:00:00+00:00",
  "notify": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "issued_by_id": 0,
  "member_id": 0,
  "group_id": 0,
  "place_id": 0,
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "issued_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "member": {
    "id": 0,
    "name": "name",
    "card_enabled": false,
    "link_enabled": false,
    "login_enabled": false
  },
  "group": {
    "id": 0,
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "card_enabled": {
      "type": "boolean"
    },
    "link_enabled": {
      "type": "boolean"
    },
    "login_enabled": {
      "type": "boolean"
    },
    "apply_to_place": {
      "type": "boolean"
    },
    "valid_from": {
      "type": "string"
    },
    "valid_until": {
      "type": "string"
    },
    "notify": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "issued_by_id": {
      "type": "number"
    },
    "member_id": {
      "type": "number"
    },
    "group_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "issued_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "member": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "card_enabled": {
          "type": "boolean"
        },
        "link_enabled": {
          "type": "boolean"
        },
        "login_enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "group": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "email",
    "created_at",
    "updated_at",
    "user_id",
    "issued_by_id",
    "member_id",
    "group_id",
    "place_id",
    "user",
    "issued_by",
    "member",
    "group",
    "place"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "share": {
    "role": "null",
    "card_enabled": false,
    "link_enabled": false,
    "login_enabled": false,
    "valid_from": "0000-01-01T00:00:00+00:00",
    "valid_until": "0000-01-01T00:00:00+00:00",
    "notify": true
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "share": {
      "type": "object",
      "properties": {
        "role": {
          "type": "string"
        },
        "card_enabled": {
          "type": "boolean"
        },
        "link_enabled": {
          "type": "boolean"
        },
        "login_enabled": {
          "type": "boolean"
        },
        "valid_from": {
          "type": "string"
        },
        "valid_until": {
          "type": "string"
        },
        "notify": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "share"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Destroy.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Cards

Cards.

Cards Collection

Index

Index.

REQUEST

Parameters
activated boolean true -
assigned boolean true -
user_id number 0 -
assigned_by_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "type": "type",
    "token": "token",
    "uid": "uid",
    "third_party": false,
    "assigned": true,
    "assigned_at": "0000-01-01T00:00:00+00:00",
    "activated": true,
    "activated_at": "0000-01-01T00:00:00+00:00",
    "deactivated_at": "0000-01-01T00:00:00+00:00",
    "last_used_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "user_id": 0,
    "user": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "assigned_by": {
      "id": 0,
      "email": "email",
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Cards Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "type",
  "token": "token",
  "uid": "uid",
  "third_party": false,
  "assigned": true,
  "assigned_at": "0000-01-01T00:00:00+00:00",
  "activated": true,
  "activated_at": "0000-01-01T00:00:00+00:00",
  "deactivated_at": "0000-01-01T00:00:00+00:00",
  "last_used_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "user_id": 0,
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "assigned_by": {
    "id": 0,
    "email": "email",
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "uid": {
      "type": "string",
      "description": "UID"
    },
    "third_party": {
      "type": "boolean"
    },
    "assigned": {
      "type": "boolean"
    },
    "assigned_at": {
      "type": "string"
    },
    "activated": {
      "type": "boolean"
    },
    "activated_at": {
      "type": "string"
    },
    "deactivated_at": {
      "type": "string"
    },
    "last_used_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "user_id": {
      "type": "number"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "assigned_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "token",
    "uid",
    "third_party",
    "assigned",
    "assigned_at",
    "activated",
    "activated_at",
    "deactivated_at",
    "last_used_at",
    "created_at",
    "updated_at",
    "user_id"
  ]
}
                      

Assign

Assign.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "card": {
    "email": "email"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "card": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      },
      "required": [
        "email"
      ]
    }
  },
  "required": [
    "card"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Assign

Assign member.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "card": {
    "email": "email",
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "card": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "email",
        "place_id"
      ]
    }
  },
  "required": [
    "card"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Deassign

Deassign.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Deassign

Deassign member.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "card": {
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "card": {
      "type": "object",
      "properties": {
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "place_id"
      ]
    }
  },
  "required": [
    "card"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Activate

Activates a card.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Deactivate

Deactivate.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Activate

Activate.

REQUEST

Parameters
activation_token string token -
id number 0 -
Headers
Content-Type application/json
Accept application/json

RESPONSE

Headers
Content-Type application/json

Deactivate

Deactivate.

REQUEST

Parameters
deactivation_token string token -
id number 0 -
Headers
Content-Type application/json
Accept application/json

RESPONSE

Headers
Content-Type application/json
Cards Member By UID

Assignment

Retrieve a card’s assignment assignment.

REQUEST

Parameters
place_id number 0 -
uid string uid -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "type",
  "token": "token",
  "uid": "uid",
  "third_party": false,
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "member": {
    "id": 0,
    "name": "name",
    "image": "image",
    "backup": true
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "uid": {
      "type": "string",
      "description": "UID"
    },
    "third_party": {
      "type": "boolean"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "member": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "backup": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name",
        "image",
        "backup"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "token",
    "uid",
    "third_party",
    "user",
    "member"
  ]
}
                      
Cards Member By Token

Assignment

Retrieve a card’s assignment assignment.

REQUEST

Parameters
place_id number 0 -
token string token -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <token>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "type",
  "token": "token",
  "uid": "uid",
  "third_party": false,
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "member": {
    "id": 0,
    "name": "name",
    "image": "image",
    "backup": true
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "uid": {
      "type": "string",
      "description": "UID"
    },
    "third_party": {
      "type": "boolean"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "member": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "image": {
          "type": "string"
        },
        "backup": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name",
        "image",
        "backup"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "token",
    "uid",
    "third_party",
    "user",
    "member"
  ]
}
                      
Integrations

Integrations.

Integrations Collection

Index

Index.

REQUEST

Parameters
query string query -
type string type -
enabled boolean true -
group_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "type": "type",
    "name": "name",
    "enabled": true,
    "automatically_disabled": true,
    "automatically_disabled_at": "0000-01-01T00:00:00+00:00",
    "active_directory_tenant_id": "id",
    "active_directory_group_id": "id",
    "url": "url",
    "google_calendar_id": "id",
    "google_org_unit_id": "id",
    "import_members_only": true,
    "credential_secret": "abc123",
    "errors_count": 0,
    "last_executed_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "group_id": 0,
    "lock_id": 0,
    "place_id": 0,
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "integration": {
    "type": "type",
    "name": "name",
    "enabled": true,
    "active_directory_tenant_id": "id",
    "active_directory_group_id": "id",
    "url": "url",
    "google_calendar_id": "id",
    "google_org_unit_id": "id",
    "import_members_only": true,
    "credential_secret": "abc123",
    "group_id": 0,
    "lock_id": 0,
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "integration": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "active_directory_tenant_id": {
          "type": "string"
        },
        "active_directory_group_id": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "google_calendar_id": {
          "type": "string"
        },
        "google_org_unit_id": {
          "type": "string"
        },
        "import_members_only": {
          "type": "boolean"
        },
        "credential_secret": {
          "type": "string"
        },
        "group_id": {
          "type": "number"
        },
        "lock_id": {
          "type": "number"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "type",
        "name",
        "url",
        "google_calendar_id",
        "google_org_unit_id",
        "import_members_only",
        "credential_secret",
        "group_id",
        "lock_id",
        "place_id"
      ]
    }
  },
  "required": [
    "integration"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "type",
  "name": "name",
  "enabled": true,
  "automatically_disabled": true,
  "automatically_disabled_at": "0000-01-01T00:00:00+00:00",
  "active_directory_tenant_id": "id",
  "active_directory_group_id": "id",
  "url": "url",
  "google_calendar_id": "id",
  "google_org_unit_id": "id",
  "import_members_only": true,
  "credential_secret": "abc123",
  "errors_count": 0,
  "last_executed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "group_id": 0,
  "lock_id": 0,
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "automatically_disabled": {
      "type": "boolean"
    },
    "automatically_disabled_at": {
      "type": "string"
    },
    "active_directory_tenant_id": {
      "type": "string"
    },
    "active_directory_group_id": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "google_calendar_id": {
      "type": "string"
    },
    "google_org_unit_id": {
      "type": "string"
    },
    "import_members_only": {
      "type": "boolean"
    },
    "credential_secret": {
      "type": "string"
    },
    "errors_count": {
      "type": "number"
    },
    "last_executed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "group_id": {
      "type": "number"
    },
    "lock_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "name",
    "enabled",
    "automatically_disabled",
    "automatically_disabled_at",
    "url",
    "google_calendar_id",
    "google_org_unit_id",
    "import_members_only",
    "credential_secret",
    "errors_count",
    "last_executed_at",
    "created_at",
    "updated_at",
    "group_id",
    "lock_id",
    "place_id",
    "place"
  ]
}
                      
Integrations Member

Show

Retrieves an integration by id.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "type",
  "name": "name",
  "enabled": true,
  "automatically_disabled": true,
  "automatically_disabled_at": "0000-01-01T00:00:00+00:00",
  "active_directory_tenant_id": "id",
  "active_directory_group_id": "id",
  "url": "url",
  "google_calendar_id": "id",
  "google_org_unit_id": "id",
  "import_members_only": true,
  "credential_secret": "abc123",
  "errors_count": 0,
  "last_executed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "group_id": 0,
  "lock_id": 0,
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "automatically_disabled": {
      "type": "boolean"
    },
    "automatically_disabled_at": {
      "type": "string"
    },
    "active_directory_tenant_id": {
      "type": "string"
    },
    "active_directory_group_id": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "google_calendar_id": {
      "type": "string"
    },
    "google_org_unit_id": {
      "type": "string"
    },
    "import_members_only": {
      "type": "boolean"
    },
    "credential_secret": {
      "type": "string"
    },
    "errors_count": {
      "type": "number"
    },
    "last_executed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "group_id": {
      "type": "number"
    },
    "lock_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "name",
    "enabled",
    "automatically_disabled",
    "automatically_disabled_at",
    "url",
    "google_calendar_id",
    "google_org_unit_id",
    "import_members_only",
    "credential_secret",
    "errors_count",
    "last_executed_at",
    "created_at",
    "updated_at",
    "group_id",
    "lock_id",
    "place_id",
    "place"
  ]
}
                      

Update

Updates an integration by id.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "integration": {
    "name": "name",
    "enabled": true,
    "active_directory_tenant_id": "id",
    "active_directory_group_id": "id",
    "url": "url",
    "google_calendar_id": "id",
    "google_org_unit_id": "id",
    "import_members_only": true,
    "credential_secret": "abc123",
    "group_id": 0,
    "lock_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "integration": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "active_directory_tenant_id": {
          "type": "string"
        },
        "active_directory_group_id": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "google_calendar_id": {
          "type": "string"
        },
        "google_org_unit_id": {
          "type": "string"
        },
        "import_members_only": {
          "type": "boolean"
        },
        "credential_secret": {
          "type": "string"
        },
        "group_id": {
          "type": "number"
        },
        "lock_id": {
          "type": "number"
        }
      },
      "required": [
        "name",
        "url",
        "google_calendar_id",
        "google_org_unit_id",
        "import_members_only",
        "credential_secret",
        "group_id",
        "lock_id"
      ]
    }
  },
  "required": [
    "integration"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Deletes an integration by id.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Gateways

Gateways.

Gateways Collection

Index

Index.

REQUEST

Parameters
query string query -
model string model -
online boolean true -
place_id number 0 -
user_id number 0 -
Headers
Content-Type application/json
application/json
                              Accept: application/json
    Authorization: KISI-LOGIN <secret>

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "description": "description",
    "model": "model",
    "device_id: `device_id`": "",
    "mac": "mac",
    "ethernet_mac: `ethernet_mac`": "",
    "wifi_mac: `wifi_mac`": "",
    "online": true,
    "online_since": "0000-01-01T00:00:00+00:00",
    "offline_since": "0000-01-01T00:00:00+00:00",
    "assigned": true,
    "assigned_to_place": true,
    "assigned_to_user": true,
    "updated_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "user": {
      "id": 0,
      "email": "email",
      "name": "name"
    },
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Gateways Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "description": "description",
  "model": "model",
  "device_id: `device_id`": "",
  "mac": "mac",
  "ethernet_mac: `ethernet_mac`": "",
  "wifi_mac: `wifi_mac`": "",
  "online": true,
  "online_since": "0000-01-01T00:00:00+00:00",
  "offline_since": "0000-01-01T00:00:00+00:00",
  "assigned": true,
  "assigned_to_place": true,
  "assigned_to_user": true,
  "updated_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "user": {
    "id": 0,
    "email": "email",
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "device_id: `device_id`": {
      "type": "string"
    },
    "mac": {
      "type": "string"
    },
    "ethernet_mac: `ethernet_mac`": {
      "type": "string"
    },
    "wifi_mac: `wifi_mac`": {
      "type": "string"
    },
    "online": {
      "type": "boolean"
    },
    "online_since": {
      "type": "string"
    },
    "offline_since": {
      "type": "string"
    },
    "assigned": {
      "type": "boolean"
    },
    "assigned_to_place": {
      "type": "boolean"
    },
    "assigned_to_user": {
      "type": "boolean"
    },
    "updated_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "email": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "email",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "model",
    "device_id: `device_id`",
    "mac",
    "ethernet_mac: `ethernet_mac`",
    "wifi_mac: `wifi_mac`",
    "online",
    "online_since",
    "offline_since",
    "assigned",
    "assigned_to_place",
    "assigned_to_user",
    "updated_at",
    "created_at"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "gateway": {
    "name": "name",
    "description": "description"
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "gateway": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "gateway"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Assign

Assign.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "gateway": {
    "name": "name",
    "description": "description",
    "place_id": 0
  }
}
                        
                          
                        

RESPONSE

Headers
Content-Type application/json

Assign

Assign.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "gateway": {
    "name": "name",
    "description": "description",
    "place_id": 0
  }
}
                        
                          
                        

RESPONSE

Headers
Content-Type application/json

Deassign

Deassign.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Beacons

Beacons.

Beacons Collection

Index

Index.

REQUEST

Parameters
lock_id number 0 -
gateway_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "channel": "0",
    "enabled": true,
    "tap_enabled": true,
    "notification_enabled": true,
    "action_on_access": "unlock",
    "transmission": "type",
    "uuid": "uuid",
    "major": 0,
    "minor": 0,
    "last_accessed_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "lock_id": 0,
    "gateway_id": 0,
    "lock": {
      "id": 0,
      "name": "name"
    },
    "gateway": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Beacons Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "channel": "0",
  "enabled": true,
  "tap_enabled": true,
  "notification_enabled": true,
  "action_on_access": "unlock",
  "transmission": "type",
  "uuid": "uuid",
  "major": 0,
  "minor": 0,
  "last_accessed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "lock_id": 0,
  "gateway_id": 0,
  "lock": {
    "id": 0,
    "name": "name"
  },
  "gateway": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "tap_enabled": {
      "type": "boolean"
    },
    "notification_enabled": {
      "type": "boolean"
    },
    "action_on_access": {
      "type": "string"
    },
    "transmission": {
      "type": "string"
    },
    "uuid": {
      "type": "string"
    },
    "major": {
      "type": "number"
    },
    "minor": {
      "type": "number"
    },
    "last_accessed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "lock_id": {
      "type": "number"
    },
    "gateway_id": {
      "type": "number"
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "gateway": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "channel",
    "transmission",
    "uuid",
    "major",
    "minor",
    "last_accessed_at",
    "created_at",
    "updated_at",
    "lock_id",
    "gateway_id",
    "gateway"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "beacon": {
    "name": "name",
    "enabled": true,
    "tap_enabled": true,
    "notification_enabled": true,
    "action_on_access": "unlock",
    "lock_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "beacon": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "tap_enabled": {
          "type": "boolean"
        },
        "notification_enabled": {
          "type": "boolean"
        },
        "action_on_access": {
          "type": "string"
        },
        "lock_id": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "beacon"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
Card Readers

Card readers.

Card Readers Collection

Index

Index.

REQUEST

Parameters
gateway_id number 0 -
lock_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "channel": "0",
    "enabled": true,
    "action_on_access": "unlock",
    "last_accessed_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "lock_id": 0,
    "gateway_id": 0,
    "lock": {
      "id": 0,
      "name": "name"
    },
    "gateway": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Card Readers Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "channel": "0",
  "enabled": true,
  "action_on_access": "unlock",
  "last_accessed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "lock_id": 0,
  "gateway_id": 0,
  "lock": {
    "id": 0,
    "name": "name"
  },
  "gateway": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "action_on_access": {
      "type": "string"
    },
    "last_accessed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "lock_id": {
      "type": "number"
    },
    "gateway_id": {
      "type": "number"
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "gateway": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "channel",
    "last_accessed_at",
    "created_at",
    "updated_at",
    "lock_id",
    "gateway_id",
    "gateway"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "card_reader": {
    "name": "name",
    "enabled": true,
    "action_on_access": "unlock",
    "lock_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "card_reader": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "action_on_access": {
          "type": "string"
        },
        "lock_id": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "card_reader"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
Contact Sensors

Contact sensors.

Contact Sensors Collection

Index

Index.

REQUEST

Parameters
lock_id number 0 -
gateway_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "channel": "0",
    "enabled": true,
    "pin": 0,
    "open": true,
    "last_opened_at": "0000-01-01T00:00:00+00:00",
    "last_closed_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "lock_id": 0,
    "gateway_id": 0,
    "lock": {
      "id": 0,
      "name": "name"
    },
    "gateway": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Contact Sensors Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "channel": "0",
  "enabled": true,
  "pin": 0,
  "open": true,
  "last_opened_at": "0000-01-01T00:00:00+00:00",
  "last_closed_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "lock_id": 0,
  "gateway_id": 0,
  "lock": {
    "id": 0,
    "name": "name"
  },
  "gateway": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "pin": {
      "type": "number"
    },
    "open": {
      "type": "boolean"
    },
    "last_opened_at": {
      "type": "string"
    },
    "last_closed_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "lock_id": {
      "type": "number"
    },
    "gateway_id": {
      "type": "number"
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "gateway": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "channel",
    "enabled",
    "pin",
    "open",
    "last_opened_at",
    "last_closed_at",
    "created_at",
    "updated_at",
    "lock_id",
    "gateway_id",
    "gateway"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "contact_sensor": {
    "name": "name",
    "enabled": true,
    "lock_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "contact_sensor": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "lock_id": {
          "type": "number"
        }
      },
      "required": [
        "enabled"
      ]
    }
  },
  "required": [
    "contact_sensor"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
Relays

Relays.

Relays Collection

Index

Retrieves all relays the user is allowed to see.

REQUEST

Parameters
lock_id number 0

lock id

gateway_id number 0

gateway id

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "Kisi Reader",
    "channel": "0",
    "pin": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "gateway_id": 0,
    "gateway": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Relays Member

Show

Retrieves a relay by id.

REQUEST

Parameters
id number 0

id

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "Kisi Reader",
  "channel": "0",
  "pin": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "gateway_id": 0,
  "gateway": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "id"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "channel": {
      "type": "string",
      "description": "channel"
    },
    "pin": {
      "type": "number",
      "description": "pin"
    },
    "created_at": {
      "type": "string",
      "description": "created at"
    },
    "updated_at": {
      "type": "string",
      "description": "updated at"
    },
    "gateway_id": {
      "type": "number",
      "description": "gateway id"
    },
    "gateway": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "gateway id"
        },
        "name": {
          "type": "string",
          "description": "gateway name"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "description": "gateway"
    }
  },
  "required": [
    "id",
    "name",
    "channel",
    "pin",
    "created_at",
    "updated_at",
    "gateway_id",
    "gateway"
  ]
}
                      

Update

Updates a relay by id.

REQUEST

Parameters
id number 0

id

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "relay": {
    "name": "Kisi Reader",
    "channel": "0",
    "pin": 0,
    "gateway_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "relay": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "name"
        },
        "channel": {
          "type": "string",
          "description": "channel"
        },
        "pin": {
          "type": "number",
          "description": "pin"
        },
        "gateway_id": {
          "type": "number",
          "description": "gateway id"
        }
      },
      "required": [
        "name",
        "channel",
        "pin",
        "gateway_id"
      ]
    }
  },
  "required": [
    "relay"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
Request To Exits

Request to exits.

Request To Exits Collection

Index

Index.

REQUEST

Parameters
lock_id number 0 -
gateway_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "channel": "0",
    "name": "Kisi Reader",
    "enabled": true,
    "pin": 0,
    "action_on_triggered": "action",
    "last_triggered_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "lock_id": 0,
    "gateway_id": 0,
    "lock": {
      "id": 0,
      "name": "name"
    },
    "gateway": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Request To Exits Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "channel": "0",
  "name": "Kisi Reader",
  "enabled": true,
  "pin": 0,
  "action_on_triggered": "action",
  "last_triggered_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "lock_id": 0,
  "gateway_id": 0,
  "lock": {
    "id": 0,
    "name": "name"
  },
  "gateway": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "channel": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "pin": {
      "type": "number"
    },
    "action_on_triggered": {
      "type": "string"
    },
    "last_triggered_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "lock_id": {
      "type": "number"
    },
    "gateway_id": {
      "type": "number"
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "gateway": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "channel",
    "name",
    "pin",
    "action_on_triggered",
    "last_triggered_at",
    "created_at",
    "updated_at",
    "lock_id",
    "gateway_id",
    "gateway"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "request_to_exit": {
    "name": "name",
    "enabled": true,
    "action_on_triggered": "unlock",
    "lock_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "request_to_exit": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "action_on_triggered": {
          "type": "string"
        },
        "lock_id": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "request_to_exit"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
Wireless Locks

Wireless locks.

Wireless Locks Collection

Index

Index.

REQUEST

Parameters
gateway_id number 0 -
lock_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "channel": "0",
    "enabled": true,
    "online": true,
    "duration": 3,
    "model": "model",
    "address": "address",
    "firmware_version: `firmware_version`": "",
    "serial_number: `serial_number`": "",
    "battery_level": "low",
    "unlocked": true,
    "open": true,
    "last_unlocked_at": "0000-01-01T00:00:00+00:00",
    "last_opened_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "lock_id": 0,
    "gateway_id": 0,
    "lock": {
      "id": 0,
      "name": "name"
    },
    "gateway": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Wireless Locks Member

Show

Show.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "channel": "0",
  "enabled": true,
  "online": true,
  "duration": 3,
  "model": "model",
  "address": "address",
  "firmware_version: `firmware_version`": "",
  "serial_number: `serial_number`": "",
  "battery_level": "low",
  "unlocked": true,
  "open": true,
  "last_unlocked_at": "0000-01-01T00:00:00+00:00",
  "last_opened_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "lock_id": 0,
  "gateway_id": 0,
  "lock": {
    "id": 0,
    "name": "name"
  },
  "gateway": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "channel": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "online": {
      "type": "boolean"
    },
    "duration": {
      "type": "number"
    },
    "model": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "firmware_version: `firmware_version`": {
      "type": "string"
    },
    "serial_number: `serial_number`": {
      "type": "string"
    },
    "battery_level": {
      "type": "string"
    },
    "unlocked": {
      "type": "boolean"
    },
    "open": {
      "type": "boolean"
    },
    "last_unlocked_at": {
      "type": "string"
    },
    "last_opened_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "lock_id": {
      "type": "number"
    },
    "gateway_id": {
      "type": "number"
    },
    "lock": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "gateway": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "channel",
    "enabled",
    "online",
    "duration",
    "model",
    "address",
    "firmware_version: `firmware_version`",
    "serial_number: `serial_number`",
    "battery_level",
    "unlocked",
    "open",
    "last_unlocked_at",
    "last_opened_at",
    "created_at",
    "updated_at",
    "lock_id",
    "gateway_id",
    "gateway"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "wireless_lock": {
    "name": "name",
    "enabled": true,
    "duration": 3,
    "lock_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "wireless_lock": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "duration": {
          "type": "number"
        },
        "lock_id": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "wireless_lock"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
Events

Events.

Events Collection

Index Place

Place events.

REQUEST

Parameters
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": "0",
    "actor_type: `actor_type`": "",
    "actor_id": 0,
    "object_type: `object_type`": "",
    "object_id": 0,
    "success": true,
    "code": "af4bcd",
    "message": "Anders Svensson unlocked door Entrance",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "references": [
      {
        "type": "Type",
        "id": "0"
      }
    ]
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Index Gateway

Gateway events.

REQUEST

Parameters
gateway_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": "0",
    "actor_type: `actor_type`": "",
    "actor_id": 0,
    "object_type: `object_type`": "",
    "object_id": 0,
    "success": true,
    "code": "af4bcd",
    "message": "Anders Svensson unlocked door Entrance",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "references": [
      {
        "type": "Type",
        "id": "0"
      }
    ]
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Index User

User events.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": "0",
    "actor_type: `actor_type`": "",
    "actor_id": 0,
    "object_type: `object_type`": "",
    "object_id": 0,
    "success": true,
    "code": "af4bcd",
    "message": "Anders Svensson unlocked door Entrance",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "references": [
      {
        "type": "Type",
        "id": "0"
      }
    ]
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Events Member

Show

Show.

REQUEST

Parameters
id number 1 -
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": "0",
  "actor_type: `actor_type`": "",
  "actor_id": 0,
  "object_type: `object_type`": "",
  "object_id": 0,
  "success": true,
  "code": "af4bcd",
  "message": "Anders Svensson unlocked door Entrance",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "references": [
    {
      "type": "Type",
      "id": "0"
    }
  ]
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "actor_type: `actor_type`": {
      "type": "string"
    },
    "actor_id": {
      "type": "number"
    },
    "action": {
      "type": "string"
    },
    "object_type: `object_type`": {
      "type": "string"
    },
    "object_id": {
      "type": "number"
    },
    "success": {
      "type": "boolean"
    },
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "references": {
      "type": "array"
    }
  },
  "required": [
    "id",
    "actor_type: `actor_type`",
    "actor_id",
    "object_type: `object_type`",
    "object_id",
    "success",
    "code",
    "message",
    "created_at",
    "updated_at",
    "references"
  ]
}
                      
Event Exports

Event Exports.

Event Exports Collection

Index

Index.

REQUEST

Parameters
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "status": "status",
    "progress": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "place_id": 0,
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "event_export": {
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "event_export": {
      "type": "object",
      "properties": {
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "place_id"
      ]
    }
  },
  "required": [
    "event_export"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "status": "status",
  "progress": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "created_at",
    "updated_at",
    "place_id",
    "place"
  ]
}
                      
Event Exports Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "status": "status",
  "progress": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "created_at",
    "updated_at",
    "place_id",
    "place"
  ]
}
                      

Download

Download.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "status": "status",
  "progress": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "place_id": 0,
  "place": {
    "id": 0,
    "name": "name"
  },
  "url": "url"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "place_id": {
      "type": "number"
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "created_at",
    "updated_at",
    "place_id",
    "place",
    "url"
  ]
}
                      
Watchers

Watchers.

Watchers Collection

Index

Index.

REQUEST

Parameters
muted boolean false -
object_type string type -
object_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "object_type": "actor",
    "object_id": 0,
    "muted": true,
    "notify_via_email": true,
    "notify_via_push": true,
    "notify_on_beacon_changed": true,
    "notify_on_card_reader_changed": true,
    "notify_on_card_assignment_changed": true,
    "notify_on_card_activation_changed": true,
    "notify_on_contact_sensor_changed": true,
    "notify_on_contact_sensor_triggered": true,
    "notify_on_contact_sensor_tripped": true,
    "notify_on_gateway_changed": true,
    "notify_on_gateway_assignment_changed": true,
    "notify_on_gateway_connectivity_changed": true,
    "notify_on_group_changed": true,
    "notify_on_group_lock_unlocked": true,
    "notify_on_group_group_lock_changed": true,
    "notify_on_group_share_changed": true,
    "notify_on_integration_changed": true,
    "notify_on_lock_changed": true,
    "notify_on_member_changed": true,
    "notify_on_member_card_changed": true,
    "notify_on_member_share_changed": true,
    "notify_on_member_lock_unlocked": true,
    "notify_on_place_changed": true,
    "notify_on_place_transfer_changed": true,
    "notify_on_presence_changed": true,
    "notify_on_relay_changed": true,
    "notify_on_request_to_exit_changed": true,
    "notify_on_triggered": true,
    "notify_on_share_changed": true,
    "notify_on_subscription_changed": true,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00"
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "watcher": {
    "object_type": "object",
    "object_id": 0,
    "notify_via_email": true,
    "notify_via_push": true,
    "notify_on_beacon_changed": true,
    "notify_on_card_reader_changed": true,
    "notify_on_card_assignment_changed": true,
    "notify_on_card_activation_changed": true,
    "notify_on_contact_sensor_changed": true,
    "notify_on_contact_sensor_triggered": true,
    "notify_on_contact_sensor_tripped": true,
    "notify_on_gateway_changed": true,
    "notify_on_gateway_assignment_changed": true,
    "notify_on_gateway_connectivity_changed": true,
    "notify_on_group_changed": true,
    "notify_on_group_lock_unlocked": true,
    "notify_on_group_group_lock_changed": true,
    "notify_on_group_share_changed": true,
    "notify_on_integration_changed": true,
    "notify_on_lock_changed": true,
    "notify_on_member_changed": true,
    "notify_on_member_card_changed": true,
    "notify_on_member_share_changed": true,
    "notify_on_member_lock_unlocked": true,
    "notify_on_place_changed": true,
    "notify_on_place_transfer_changed": true,
    "notify_on_presence_changed": true,
    "notify_on_relay_changed": true,
    "notify_on_request_to_exit_changed": true,
    "notify_on_triggered": true,
    "notify_on_share_changed": true,
    "notify_on_subscription_changed": true
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "watcher": {
      "type": "object",
      "properties": {
        "object_type": {
          "type": "string"
        },
        "object_id": {
          "type": "number"
        },
        "notify_via_email": {
          "type": "boolean"
        },
        "notify_via_push": {
          "type": "boolean"
        },
        "notify_on_beacon_changed": {
          "type": "boolean"
        },
        "notify_on_card_reader_changed": {
          "type": "boolean"
        },
        "notify_on_card_assignment_changed": {
          "type": "boolean"
        },
        "notify_on_card_activation_changed": {
          "type": "boolean"
        },
        "notify_on_contact_sensor_changed": {
          "type": "boolean"
        },
        "notify_on_contact_sensor_triggered": {
          "type": "boolean"
        },
        "notify_on_contact_sensor_tripped": {
          "type": "boolean"
        },
        "notify_on_gateway_changed": {
          "type": "boolean"
        },
        "notify_on_gateway_assignment_changed": {
          "type": "boolean"
        },
        "notify_on_gateway_connectivity_changed": {
          "type": "boolean"
        },
        "notify_on_group_changed": {
          "type": "boolean"
        },
        "notify_on_group_lock_unlocked": {
          "type": "boolean"
        },
        "notify_on_group_group_lock_changed": {
          "type": "boolean"
        },
        "notify_on_group_share_changed": {
          "type": "boolean"
        },
        "notify_on_integration_changed": {
          "type": "boolean"
        },
        "notify_on_lock_changed": {
          "type": "boolean"
        },
        "notify_on_member_changed": {
          "type": "boolean"
        },
        "notify_on_member_card_changed": {
          "type": "boolean"
        },
        "notify_on_member_share_changed": {
          "type": "boolean"
        },
        "notify_on_member_lock_unlocked": {
          "type": "boolean"
        },
        "notify_on_place_changed": {
          "type": "boolean"
        },
        "notify_on_place_transfer_changed": {
          "type": "boolean"
        },
        "notify_on_presence_changed": {
          "type": "boolean"
        },
        "notify_on_relay_changed": {
          "type": "boolean"
        },
        "notify_on_request_to_exit_changed": {
          "type": "boolean"
        },
        "notify_on_triggered": {
          "type": "boolean"
        },
        "notify_on_share_changed": {
          "type": "boolean"
        },
        "notify_on_subscription_changed": {
          "type": "boolean"
        }
      },
      "required": [
        "object_type",
        "object_id"
      ]
    }
  },
  "required": [
    "watcher"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "object_type": "actor",
  "object_id": 0,
  "muted": true,
  "notify_via_email": true,
  "notify_via_push": true,
  "notify_on_beacon_changed": true,
  "notify_on_card_reader_changed": true,
  "notify_on_card_assignment_changed": true,
  "notify_on_card_activation_changed": true,
  "notify_on_contact_sensor_changed": true,
  "notify_on_contact_sensor_triggered": true,
  "notify_on_contact_sensor_tripped": true,
  "notify_on_gateway_changed": true,
  "notify_on_gateway_assignment_changed": true,
  "notify_on_gateway_connectivity_changed": true,
  "notify_on_group_changed": true,
  "notify_on_group_lock_unlocked": true,
  "notify_on_group_group_lock_changed": true,
  "notify_on_group_share_changed": true,
  "notify_on_integration_changed": true,
  "notify_on_lock_changed": true,
  "notify_on_member_changed": true,
  "notify_on_member_card_changed": true,
  "notify_on_member_share_changed": true,
  "notify_on_member_lock_unlocked": true,
  "notify_on_place_changed": true,
  "notify_on_place_transfer_changed": true,
  "notify_on_presence_changed": true,
  "notify_on_relay_changed": true,
  "notify_on_request_to_exit_changed": true,
  "notify_on_triggered": true,
  "notify_on_share_changed": true,
  "notify_on_subscription_changed": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "object_type": {
      "type": "string"
    },
    "object_id": {
      "type": "number"
    },
    "muted": {
      "type": "boolean"
    },
    "notify_via_email": {
      "type": "boolean"
    },
    "notify_via_push": {
      "type": "boolean"
    },
    "notify_on_beacon_changed": {
      "type": "boolean"
    },
    "notify_on_card_reader_changed": {
      "type": "boolean"
    },
    "notify_on_card_assignment_changed": {
      "type": "boolean"
    },
    "notify_on_card_activation_changed": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_changed": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_triggered": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_tripped": {
      "type": "boolean"
    },
    "notify_on_gateway_changed": {
      "type": "boolean"
    },
    "notify_on_gateway_assignment_changed": {
      "type": "boolean"
    },
    "notify_on_gateway_connectivity_changed": {
      "type": "boolean"
    },
    "notify_on_group_changed": {
      "type": "boolean"
    },
    "notify_on_group_lock_unlocked": {
      "type": "boolean"
    },
    "notify_on_group_group_lock_changed": {
      "type": "boolean"
    },
    "notify_on_group_share_changed": {
      "type": "boolean"
    },
    "notify_on_integration_changed": {
      "type": "boolean"
    },
    "notify_on_lock_changed": {
      "type": "boolean"
    },
    "notify_on_member_changed": {
      "type": "boolean"
    },
    "notify_on_member_card_changed": {
      "type": "boolean"
    },
    "notify_on_member_share_changed": {
      "type": "boolean"
    },
    "notify_on_member_lock_unlocked": {
      "type": "boolean"
    },
    "notify_on_place_changed": {
      "type": "boolean"
    },
    "notify_on_place_transfer_changed": {
      "type": "boolean"
    },
    "notify_on_presence_changed": {
      "type": "boolean"
    },
    "notify_on_relay_changed": {
      "type": "boolean"
    },
    "notify_on_request_to_exit_changed": {
      "type": "boolean"
    },
    "notify_on_triggered": {
      "type": "boolean"
    },
    "notify_on_share_changed": {
      "type": "boolean"
    },
    "notify_on_subscription_changed": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "object_type",
    "object_id",
    "created_at",
    "updated_at"
  ]
}
                      
Watchers Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "object_type": "actor",
  "object_id": 0,
  "muted": true,
  "notify_via_email": true,
  "notify_via_push": true,
  "notify_on_beacon_changed": true,
  "notify_on_card_reader_changed": true,
  "notify_on_card_assignment_changed": true,
  "notify_on_card_activation_changed": true,
  "notify_on_contact_sensor_changed": true,
  "notify_on_contact_sensor_triggered": true,
  "notify_on_contact_sensor_tripped": true,
  "notify_on_gateway_changed": true,
  "notify_on_gateway_assignment_changed": true,
  "notify_on_gateway_connectivity_changed": true,
  "notify_on_group_changed": true,
  "notify_on_group_lock_unlocked": true,
  "notify_on_group_group_lock_changed": true,
  "notify_on_group_share_changed": true,
  "notify_on_integration_changed": true,
  "notify_on_lock_changed": true,
  "notify_on_member_changed": true,
  "notify_on_member_card_changed": true,
  "notify_on_member_share_changed": true,
  "notify_on_member_lock_unlocked": true,
  "notify_on_place_changed": true,
  "notify_on_place_transfer_changed": true,
  "notify_on_presence_changed": true,
  "notify_on_relay_changed": true,
  "notify_on_request_to_exit_changed": true,
  "notify_on_triggered": true,
  "notify_on_share_changed": true,
  "notify_on_subscription_changed": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "object_type": {
      "type": "string"
    },
    "object_id": {
      "type": "number"
    },
    "muted": {
      "type": "boolean"
    },
    "notify_via_email": {
      "type": "boolean"
    },
    "notify_via_push": {
      "type": "boolean"
    },
    "notify_on_beacon_changed": {
      "type": "boolean"
    },
    "notify_on_card_reader_changed": {
      "type": "boolean"
    },
    "notify_on_card_assignment_changed": {
      "type": "boolean"
    },
    "notify_on_card_activation_changed": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_changed": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_triggered": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_tripped": {
      "type": "boolean"
    },
    "notify_on_gateway_changed": {
      "type": "boolean"
    },
    "notify_on_gateway_assignment_changed": {
      "type": "boolean"
    },
    "notify_on_gateway_connectivity_changed": {
      "type": "boolean"
    },
    "notify_on_group_changed": {
      "type": "boolean"
    },
    "notify_on_group_lock_unlocked": {
      "type": "boolean"
    },
    "notify_on_group_group_lock_changed": {
      "type": "boolean"
    },
    "notify_on_group_share_changed": {
      "type": "boolean"
    },
    "notify_on_integration_changed": {
      "type": "boolean"
    },
    "notify_on_lock_changed": {
      "type": "boolean"
    },
    "notify_on_member_changed": {
      "type": "boolean"
    },
    "notify_on_member_card_changed": {
      "type": "boolean"
    },
    "notify_on_member_share_changed": {
      "type": "boolean"
    },
    "notify_on_member_lock_unlocked": {
      "type": "boolean"
    },
    "notify_on_place_changed": {
      "type": "boolean"
    },
    "notify_on_place_transfer_changed": {
      "type": "boolean"
    },
    "notify_on_presence_changed": {
      "type": "boolean"
    },
    "notify_on_relay_changed": {
      "type": "boolean"
    },
    "notify_on_request_to_exit_changed": {
      "type": "boolean"
    },
    "notify_on_triggered": {
      "type": "boolean"
    },
    "notify_on_share_changed": {
      "type": "boolean"
    },
    "notify_on_subscription_changed": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "object_type",
    "object_id",
    "created_at",
    "updated_at"
  ]
}
                      

Show For Object

Show for object.

REQUEST

Parameters
object_type string object -
object_id number 0 -
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "object_type": "actor",
  "object_id": 0,
  "muted": true,
  "notify_via_email": true,
  "notify_via_push": true,
  "notify_on_beacon_changed": true,
  "notify_on_card_reader_changed": true,
  "notify_on_card_assignment_changed": true,
  "notify_on_card_activation_changed": true,
  "notify_on_contact_sensor_changed": true,
  "notify_on_contact_sensor_triggered": true,
  "notify_on_contact_sensor_tripped": true,
  "notify_on_gateway_changed": true,
  "notify_on_gateway_assignment_changed": true,
  "notify_on_gateway_connectivity_changed": true,
  "notify_on_group_changed": true,
  "notify_on_group_lock_unlocked": true,
  "notify_on_group_group_lock_changed": true,
  "notify_on_group_share_changed": true,
  "notify_on_integration_changed": true,
  "notify_on_lock_changed": true,
  "notify_on_member_changed": true,
  "notify_on_member_card_changed": true,
  "notify_on_member_share_changed": true,
  "notify_on_member_lock_unlocked": true,
  "notify_on_place_changed": true,
  "notify_on_place_transfer_changed": true,
  "notify_on_presence_changed": true,
  "notify_on_relay_changed": true,
  "notify_on_request_to_exit_changed": true,
  "notify_on_triggered": true,
  "notify_on_share_changed": true,
  "notify_on_subscription_changed": true,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "object_type": {
      "type": "string"
    },
    "object_id": {
      "type": "number"
    },
    "muted": {
      "type": "boolean"
    },
    "notify_via_email": {
      "type": "boolean"
    },
    "notify_via_push": {
      "type": "boolean"
    },
    "notify_on_beacon_changed": {
      "type": "boolean"
    },
    "notify_on_card_reader_changed": {
      "type": "boolean"
    },
    "notify_on_card_assignment_changed": {
      "type": "boolean"
    },
    "notify_on_card_activation_changed": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_changed": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_triggered": {
      "type": "boolean"
    },
    "notify_on_contact_sensor_tripped": {
      "type": "boolean"
    },
    "notify_on_gateway_changed": {
      "type": "boolean"
    },
    "notify_on_gateway_assignment_changed": {
      "type": "boolean"
    },
    "notify_on_gateway_connectivity_changed": {
      "type": "boolean"
    },
    "notify_on_group_changed": {
      "type": "boolean"
    },
    "notify_on_group_lock_unlocked": {
      "type": "boolean"
    },
    "notify_on_group_group_lock_changed": {
      "type": "boolean"
    },
    "notify_on_group_share_changed": {
      "type": "boolean"
    },
    "notify_on_integration_changed": {
      "type": "boolean"
    },
    "notify_on_lock_changed": {
      "type": "boolean"
    },
    "notify_on_member_changed": {
      "type": "boolean"
    },
    "notify_on_member_card_changed": {
      "type": "boolean"
    },
    "notify_on_member_share_changed": {
      "type": "boolean"
    },
    "notify_on_member_lock_unlocked": {
      "type": "boolean"
    },
    "notify_on_place_changed": {
      "type": "boolean"
    },
    "notify_on_place_transfer_changed": {
      "type": "boolean"
    },
    "notify_on_presence_changed": {
      "type": "boolean"
    },
    "notify_on_relay_changed": {
      "type": "boolean"
    },
    "notify_on_request_to_exit_changed": {
      "type": "boolean"
    },
    "notify_on_triggered": {
      "type": "boolean"
    },
    "notify_on_share_changed": {
      "type": "boolean"
    },
    "notify_on_subscription_changed": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "object_type",
    "object_id",
    "created_at",
    "updated_at"
  ]
}
                      

Update

Updates a watcher by id.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "watcher": {
    "notify_via_email": true,
    "notify_via_push": true,
    "notify_on_beacon_changed": true,
    "notify_on_card_reader_changed": true,
    "notify_on_card_assignment_changed": true,
    "notify_on_card_activation_changed": true,
    "notify_on_contact_sensor_changed": true,
    "notify_on_contact_sensor_triggered": true,
    "notify_on_contact_sensor_tripped": true,
    "notify_on_gateway_changed": true,
    "notify_on_gateway_assignment_changed": true,
    "notify_on_gateway_connectivity_changed": true,
    "notify_on_group_changed": true,
    "notify_on_group_lock_unlocked": true,
    "notify_on_group_group_lock_changed": true,
    "notify_on_group_share_changed": true,
    "notify_on_integration_changed": true,
    "notify_on_lock_changed": true,
    "notify_on_member_changed": true,
    "notify_on_member_card_changed": true,
    "notify_on_member_share_changed": true,
    "notify_on_member_lock_unlocked": true,
    "notify_on_place_changed": true,
    "notify_on_place_transfer_changed": true,
    "notify_on_presence_changed": true,
    "notify_on_relay_changed": true,
    "notify_on_request_to_exit_changed": true,
    "notify_on_triggered": true,
    "notify_on_share_changed": true,
    "notify_on_subscription_changed": true
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "watcher": {
      "type": "object",
      "properties": {
        "notify_via_email": {
          "type": "boolean"
        },
        "notify_via_push": {
          "type": "boolean"
        },
        "notify_on_beacon_changed": {
          "type": "boolean"
        },
        "notify_on_card_reader_changed": {
          "type": "boolean"
        },
        "notify_on_card_assignment_changed": {
          "type": "boolean"
        },
        "notify_on_card_activation_changed": {
          "type": "boolean"
        },
        "notify_on_contact_sensor_changed": {
          "type": "boolean"
        },
        "notify_on_contact_sensor_triggered": {
          "type": "boolean"
        },
        "notify_on_contact_sensor_tripped": {
          "type": "boolean"
        },
        "notify_on_gateway_changed": {
          "type": "boolean"
        },
        "notify_on_gateway_assignment_changed": {
          "type": "boolean"
        },
        "notify_on_gateway_connectivity_changed": {
          "type": "boolean"
        },
        "notify_on_group_changed": {
          "type": "boolean"
        },
        "notify_on_group_lock_unlocked": {
          "type": "boolean"
        },
        "notify_on_group_group_lock_changed": {
          "type": "boolean"
        },
        "notify_on_group_share_changed": {
          "type": "boolean"
        },
        "notify_on_integration_changed": {
          "type": "boolean"
        },
        "notify_on_lock_changed": {
          "type": "boolean"
        },
        "notify_on_member_changed": {
          "type": "boolean"
        },
        "notify_on_member_card_changed": {
          "type": "boolean"
        },
        "notify_on_member_share_changed": {
          "type": "boolean"
        },
        "notify_on_member_lock_unlocked": {
          "type": "boolean"
        },
        "notify_on_place_changed": {
          "type": "boolean"
        },
        "notify_on_place_transfer_changed": {
          "type": "boolean"
        },
        "notify_on_presence_changed": {
          "type": "boolean"
        },
        "notify_on_relay_changed": {
          "type": "boolean"
        },
        "notify_on_request_to_exit_changed": {
          "type": "boolean"
        },
        "notify_on_triggered": {
          "type": "boolean"
        },
        "notify_on_share_changed": {
          "type": "boolean"
        },
        "notify_on_subscription_changed": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "watcher"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json

Destroy

Deletes a watcher by id.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Mute

Mute.

REQUEST

Parameters
id number 0 -
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json

Unmute

Unmute.

REQUEST

Parameters
id number 0 -
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Notifications

Notifications.

Notifications Collection

Index

Index.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": "0",
    "actor_type: `actor_type`": "",
    "actor_id": 0,
    "title": "title",
    "message": "message",
    "read": true,
    "read_at": "0000-01-01T00:00:00+00:00",
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00"
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Index Groups

Index Groups.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {}
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Mark As Read

Mark as read.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Notifications Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": "0",
  "actor_type: `actor_type`": "",
  "actor_id": 0,
  "title": "title",
  "message": "message",
  "read": true,
  "read_at": "0000-01-01T00:00:00+00:00",
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "actor_type: `actor_type`": {
      "type": "string"
    },
    "actor_id": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "read": {
      "type": "boolean"
    },
    "read_at": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "actor_type: `actor_type`",
    "actor_id",
    "title",
    "message",
    "read",
    "read_at",
    "created_at",
    "updated_at"
  ]
}
                      

Mark As Read

Mark as read.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
Analytics Events

Analytics.

Analytics Events Collection

Histogram

Histogram.

REQUEST

Parameters
actor_type string actor -
actor_id number 0 -
action string action -
object_type string object -
object_id number 0 -
reference_type string reference -
reference_id number 0 -
from number 0 -
to number 0 -
interval string interval -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "from": 0,
    "success": 0,
    "failure": 0,
    "total": 0
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Analytics Gateways

Analytics.

Analytics Gateways Collection

Uptime

Uptime.

REQUEST

Parameters
id number 0 -
days number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "date": "0000-01-01T00:00:00+00:00",
    "uptime": 0
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Plans

Plans.

Plans Collection

Index

Index.

REQUEST

Parameters
type string type -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "type": "type",
    "name": "name",
    "description": "description",
    "billed_per: `billed_per`": "",
    "amount": 0,
    "currency": "currency",
    "interval": "interval",
    "interval_count": 0,
    "trial_period_days": 0,
    "locks_quota": 0,
    "minimum_billable_locks": 0,
    "members_quota": 0,
    "minimum_billable_members": 0,
    "integrations_quota": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00"
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Plans Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "type": "type",
  "name": "name",
  "description": "description",
  "billed_per: `billed_per`": "",
  "amount": 0,
  "currency": "currency",
  "interval": "interval",
  "interval_count": 0,
  "trial_period_days": 0,
  "locks_quota": 0,
  "minimum_billable_locks": 0,
  "members_quota": 0,
  "minimum_billable_members": 0,
  "integrations_quota": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "billed_per: `billed_per`": {
      "type": "string"
    },
    "amount": {
      "type": "number"
    },
    "currency": {
      "type": "string"
    },
    "interval": {
      "type": "string"
    },
    "interval_count": {
      "type": "number"
    },
    "trial_period_days": {
      "type": "number"
    },
    "locks_quota": {
      "type": "number"
    },
    "minimum_billable_locks": {
      "type": "number"
    },
    "members_quota": {
      "type": "number"
    },
    "minimum_billable_members": {
      "type": "number"
    },
    "integrations_quota": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "type",
    "name",
    "description",
    "billed_per: `billed_per`",
    "amount",
    "currency",
    "interval",
    "interval_count",
    "trial_period_days",
    "locks_quota",
    "minimum_billable_locks",
    "members_quota",
    "minimum_billable_members",
    "integrations_quota"
  ]
}
                      
Subscriptions

Subscriptions.

Subscriptions Collection

Index

Index.

REQUEST

Parameters
plan_id number 0 -
place_id number 0 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "name": "name",
    "cancel_at_period_end: `false` (optional, boolean) - cancel at period_end": "",
    "canceled_at": "0000-01-01T00:00:00+00:00",
    "current_period_start": "0000-01-01T00:00:00+00:00",
    "current_period_end": "0000-01-01T00:00:00+00:00",
    "ended_at": "0000-01-01T00:00:00+00:00",
    "quantity": 0,
    "status": "active",
    "tax_percent": 25,
    "trial_start": "0000-01-01T00:00:00+00:00",
    "trial_end": "0000-01-01T00:00:00+00:00",
    "quota_exhausted": false,
    "quota_exceeded": false,
    "locks_count": 0,
    "locks_quota": 0,
    "minimum_billable_locks": 0,
    "billable_locks": 0,
    "members_count": 0,
    "members_quota": 0,
    "minimum_billable_members": 0,
    "billable_members": 0,
    "integrations_count": 0,
    "integrations_quota": 0,
    "created_at": "0000-01-01T00:00:00+00:00",
    "updated_at": "0000-01-01T00:00:00+00:00",
    "plan_id": 0,
    "place_id": 0,
    "source": {
      "brand": "brand",
      "country": "country",
      "funding": "funding",
      "expiry_month": 0,
      "expiry_year": 0,
      "last_four_digits": "1234"
    },
    "plan": {
      "id": 0,
      "name": "name"
    },
    "place": {
      "id": 0,
      "name": "name"
    }
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      

Create

Create.

REQUEST

Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "subscription": {
    "coupon": "coupon",
    "stripe_token": "token",
    "plan_id": 0,
    "place_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "subscription": {
      "type": "object",
      "properties": {
        "coupon": {
          "type": "string"
        },
        "stripe_token": {
          "type": "string"
        },
        "plan_id": {
          "type": "number"
        },
        "place_id": {
          "type": "number"
        }
      },
      "required": [
        "stripe_token",
        "plan_id",
        "place_id"
      ]
    }
  },
  "required": [
    "subscription"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "cancel_at_period_end: `false` (optional, boolean) - cancel at period_end": "",
  "canceled_at": "0000-01-01T00:00:00+00:00",
  "current_period_start": "0000-01-01T00:00:00+00:00",
  "current_period_end": "0000-01-01T00:00:00+00:00",
  "ended_at": "0000-01-01T00:00:00+00:00",
  "quantity": 0,
  "status": "active",
  "tax_percent": 25,
  "trial_start": "0000-01-01T00:00:00+00:00",
  "trial_end": "0000-01-01T00:00:00+00:00",
  "quota_exhausted": false,
  "quota_exceeded": false,
  "locks_count": 0,
  "locks_quota": 0,
  "minimum_billable_locks": 0,
  "billable_locks": 0,
  "members_count": 0,
  "members_quota": 0,
  "minimum_billable_members": 0,
  "billable_members": 0,
  "integrations_count": 0,
  "integrations_quota": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "plan_id": 0,
  "place_id": 0,
  "source": {
    "brand": "brand",
    "country": "country",
    "funding": "funding",
    "expiry_month": 0,
    "expiry_year": 0,
    "last_four_digits": "1234"
  },
  "plan": {
    "id": 0,
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "cancel_at_period_end: `false` (optional, boolean) - cancel at period_end": {
      "type": "string"
    },
    "canceled_at": {
      "type": "string"
    },
    "current_period_start": {
      "type": "string"
    },
    "current_period_end": {
      "type": "string"
    },
    "ended_at": {
      "type": "string"
    },
    "quantity": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "tax_percent": {
      "type": "number"
    },
    "trial_start": {
      "type": "string"
    },
    "trial_end": {
      "type": "string"
    },
    "quota_exhausted": {
      "type": "boolean"
    },
    "quota_exceeded": {
      "type": "boolean"
    },
    "locks_count": {
      "type": "number"
    },
    "locks_quota": {
      "type": "number"
    },
    "minimum_billable_locks": {
      "type": "number"
    },
    "billable_locks": {
      "type": "number"
    },
    "members_count": {
      "type": "number"
    },
    "members_quota": {
      "type": "number"
    },
    "minimum_billable_members": {
      "type": "number"
    },
    "billable_members": {
      "type": "number"
    },
    "integrations_count": {
      "type": "number"
    },
    "integrations_quota": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "plan_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "source": {
      "type": "object",
      "properties": {
        "brand": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "funding": {
          "type": "string"
        },
        "expiry_month": {
          "type": "number"
        },
        "expiry_year": {
          "type": "number"
        },
        "last_four_digits": {
          "type": "string"
        }
      },
      "required": [
        "brand",
        "country",
        "funding",
        "expiry_month",
        "expiry_year",
        "last_four_digits"
      ]
    },
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "current_period_start",
    "current_period_end",
    "quantity",
    "status",
    "locks_count",
    "locks_quota",
    "minimum_billable_locks",
    "billable_locks",
    "members_count",
    "members_quota",
    "minimum_billable_members",
    "billable_members",
    "integrations_count",
    "integrations_quota",
    "created_at",
    "updated_at",
    "plan_id",
    "place_id",
    "plan",
    "place"
  ]
}
                      
Subscriptions Member

Show

Show.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "name": "name",
  "cancel_at_period_end: `false` (optional, boolean) - cancel at period_end": "",
  "canceled_at": "0000-01-01T00:00:00+00:00",
  "current_period_start": "0000-01-01T00:00:00+00:00",
  "current_period_end": "0000-01-01T00:00:00+00:00",
  "ended_at": "0000-01-01T00:00:00+00:00",
  "quantity": 0,
  "status": "active",
  "tax_percent": 25,
  "trial_start": "0000-01-01T00:00:00+00:00",
  "trial_end": "0000-01-01T00:00:00+00:00",
  "quota_exhausted": false,
  "quota_exceeded": false,
  "locks_count": 0,
  "locks_quota": 0,
  "minimum_billable_locks": 0,
  "billable_locks": 0,
  "members_count": 0,
  "members_quota": 0,
  "minimum_billable_members": 0,
  "billable_members": 0,
  "integrations_count": 0,
  "integrations_quota": 0,
  "created_at": "0000-01-01T00:00:00+00:00",
  "updated_at": "0000-01-01T00:00:00+00:00",
  "plan_id": 0,
  "place_id": 0,
  "source": {
    "brand": "brand",
    "country": "country",
    "funding": "funding",
    "expiry_month": 0,
    "expiry_year": 0,
    "last_four_digits": "1234"
  },
  "plan": {
    "id": 0,
    "name": "name"
  },
  "place": {
    "id": 0,
    "name": "name"
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "cancel_at_period_end: `false` (optional, boolean) - cancel at period_end": {
      "type": "string"
    },
    "canceled_at": {
      "type": "string"
    },
    "current_period_start": {
      "type": "string"
    },
    "current_period_end": {
      "type": "string"
    },
    "ended_at": {
      "type": "string"
    },
    "quantity": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "tax_percent": {
      "type": "number"
    },
    "trial_start": {
      "type": "string"
    },
    "trial_end": {
      "type": "string"
    },
    "quota_exhausted": {
      "type": "boolean"
    },
    "quota_exceeded": {
      "type": "boolean"
    },
    "locks_count": {
      "type": "number"
    },
    "locks_quota": {
      "type": "number"
    },
    "minimum_billable_locks": {
      "type": "number"
    },
    "billable_locks": {
      "type": "number"
    },
    "members_count": {
      "type": "number"
    },
    "members_quota": {
      "type": "number"
    },
    "minimum_billable_members": {
      "type": "number"
    },
    "billable_members": {
      "type": "number"
    },
    "integrations_count": {
      "type": "number"
    },
    "integrations_quota": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "plan_id": {
      "type": "number"
    },
    "place_id": {
      "type": "number"
    },
    "source": {
      "type": "object",
      "properties": {
        "brand": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "funding": {
          "type": "string"
        },
        "expiry_month": {
          "type": "number"
        },
        "expiry_year": {
          "type": "number"
        },
        "last_four_digits": {
          "type": "string"
        }
      },
      "required": [
        "brand",
        "country",
        "funding",
        "expiry_month",
        "expiry_year",
        "last_four_digits"
      ]
    },
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "place": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "current_period_start",
    "current_period_end",
    "quantity",
    "status",
    "locks_count",
    "locks_quota",
    "minimum_billable_locks",
    "billable_locks",
    "members_count",
    "members_quota",
    "minimum_billable_members",
    "billable_members",
    "integrations_count",
    "integrations_quota",
    "created_at",
    "updated_at",
    "plan_id",
    "place_id",
    "plan",
    "place"
  ]
}
                      

Update

Update.

REQUEST

Parameters
id number 1 -
Headers
Content-Type application/json
Accept application/json
Authorization KISI-LOGIN <secret>
application/json
                          {
  "subscription": {
    "coupon": "coupon",
    "stripe_token": "token",
    "plan_id": 0
  }
}
                        
                          {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "subscription": {
      "type": "object",
      "properties": {
        "coupon": {
          "type": "string"
        },
        "stripe_token": {
          "type": "string"
        },
        "plan_id": {
          "type": "number"
        }
      },
      "required": [
        "stripe_token",
        "plan_id"
      ]
    }
  },
  "required": [
    "subscription"
  ]
}
                        

RESPONSE

Headers
Content-Type application/json