{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kisi Calendars Locks API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Locks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Fetch locks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kisi.io/locks",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Filter by object IDs"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Filter by a freetext string. Properties searched: `name`\n"
              },
              {
                "name": "floor_id",
                "value": "",
                "type": "query",
                "description": "Filter by floor ID"
              },
              {
                "name": "place_id",
                "value": "",
                "type": "query",
                "description": "Filter by place ID"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of objects to return"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of objects to offset"
              },
              {
                "name": "configured",
                "value": "",
                "type": "query",
                "description": "Filter by whether the lock has been configured."
              },
              {
                "name": "online",
                "value": "",
                "type": "query",
                "description": "Filter by whether the lock is online."
              },
              {
                "name": "unlocked",
                "value": "",
                "type": "query",
                "description": "Filter by whether the lock is unlocked or locked."
              },
              {
                "name": "locked_down",
                "value": "",
                "type": "query",
                "description": "Filter by whether the lock is locked down."
              },
              {
                "name": "favorite",
                "value": "",
                "type": "query",
                "description": "Include favorite status in response and/or filter by it.\n\n`*` - include `favorite` field in response<br>\n`true` - include `favorite` field in response and return favorites<br>\n`false` - include `favorite` field in response and return non-favorites<br>\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the results. Prepend `-` to sort in reverse order.\n\n`favorite` - sort by favorite, most recent favorites first<br>\n`name` - sort by lock name, alphabetically\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of locks.\n\nWhen authenticating with a GroupLink, a subset of the Lock resource is returned.\n"
        },
        {
          "info": {
            "name": "Create lock",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create lock"
        },
        {
          "info": {
            "name": "Fetch lock",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.kisi.io/locks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              },
              {
                "name": "favorite",
                "value": "",
                "type": "query",
                "description": "Include favorite status in response"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Fetch lock"
        },
        {
          "info": {
            "name": "Update lock",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.kisi.io/locks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update lock"
        },
        {
          "info": {
            "name": "Delete lock",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.kisi.io/locks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Delete lock"
        },
        {
          "info": {
            "name": "Activate first to arrive side effects",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/first_to_arrive",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Activate first to arrive side effects"
        },
        {
          "info": {
            "name": "Reset first to arrive and disable scheduled unlock side effects",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/last_to_leave",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Reset first to arrive and disable scheduled unlock side effects"
        },
        {
          "info": {
            "name": "Unlock lock",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/unlock",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Unlock lock"
        },
        {
          "info": {
            "name": "Lock down lock",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/lock_down",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Lock down lock"
        },
        {
          "info": {
            "name": "Cancel lockdown of lock",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/cancel_lockdown",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Cancel lockdown of lock"
        },
        {
          "info": {
            "name": "Favorite a lock",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/favorite",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Favorite a lock"
        },
        {
          "info": {
            "name": "Unfavorite a lock",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.kisi.io/locks/:id/unfavorite",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Unfavorite a lock"
        }
      ]
    }
  ],
  "bundled": true
}