KISI Cameras API

openapi: 3.1.0
info:
  version: 1.0.0
  title: Kisi Calendars Cameras API
  description: "## Introduction\n\nWelcome to the Kisi API documentation. Before you read further, please read\nthe general [Kisi Docs portal](https://docs.kisi.io/).\n\n<!-- theme: info -->\n> If you want to be notified by email about updates to our API, please subscribe to our\n> [newsletter](https://2e2bc.share.hsforms.com/2OsdqtC8xRHGQ2yaS16AF7w).\n\n### Format\n\nThe Kisi API supports JSON only, so please set `Accept` and `Content-Type`\nto `application/json`. All requests and responses will use JSON as the\nformat for any data encompassed in the body of requests and responses.\n\n```http\n<METHOD> <URL> HTTP/1.1\nAccept: application/json\nContent-Type: application/json\n```\n\n### Authentication\n\nMost calls to the API will require an authenticated user. If such a user\nis not present, you will receive a 401 response.\nFor more information about authentication, see the [Kisi Docs portal](https://docs.kisi.io/api/get_started/add_necessary_headers).\n\nAPI calls must be made using HTTPS. Any calls made over plain HTTP will fail.\n\n### Rate limits\n\nFor authenticated API requests, you can make up to 5 requests per second,\nper user. Note that the limit applies per user, so requests made using\ndifferent logins for the same user share the same quota.\n\nFor unauthenticated requests, you can make up to 5 requests per second, per\nIP address.\n\nThe following endpoints have custom rate limits:\n\n| Endpoint                   | Limit            |\n|----------------------------|------------------|\n| `POST /event_sets`         | 1 per second     |\n| `POST /signed_upload_urls` | 1 per 10 seconds |\n\nIf you exceed the rate limit, a 429 response will be returned.\n\nSome best practices:\n- If you're making requests for a single user, do so serially, *not* concurrently.\n- If you're making a large number of requests for a single user, wait at least one second between each request.\n\nWe reserve the right to change these limits as needed to ensure availability.\n\n### Deprecations\n\nIn the event that some part of the API has to be deprecated, we do the following:\n\n  1. Return the `Deprecation` header with the date of when the endpoint is deprecated.\n  2. Return the `Sunset` header with the date of when the endpoint can be expected to not function anymore.\n  3. When the `Sunset` date is reached, the endpoint may go away at any time.\n\nWe recommend listening to these headers to avoid disruptions.\n\n### Error codes\n\nSome endpoints return an error code and a message. In the table below all error codes are listed.\n\n| Error code | Message                                                                                         |\n|------------|-------------------------------------------------------------------------------------------------|\n| `afc507`   | The authentication link is not valid.                                                           |\n| `afc546`   | Invalid Two Factor backup code.                                                                 |\n| `faa9ff`   | The card is not activated.                                                                      |\n| `faa9ef`   | The card was not found.                                                                         |\n| `afc496`   | Access denied.                                                                                  |\n| `f29aef`   | Your link is invalid.                                                                           |\n| `afc516`   | Wrong email address or password.                                                                |\n| `afc536`   | Invalid Two Factor verification code.                                                           |\n| `afc526`   | Please provide a Two Factor verification code.                                                  |\n| `afc516`   | The two factor pin is invalid                                                                   |\n| `ffffff`   | An unexpected issue occured.                                                                    |\n| `fcd8ef`   | Access denied.                                                                                  |\n| `fcd8ff`   | Access disabled.                                                                                |\n| `cabbeb`   | A card with the same identifiers was already enrolled.                                          |\n| `bb4fff`   | Please authorize Kisi for Bluetooth.                                                            |\n| `bb5bff`   | No nearby Kisi reader found. Try enabling Bluetooth on your device.                             |\n| `bb4bff`   | Please enable Bluetooth.                                                                        |\n| `a7793f`   | Please authorize Kisi for location services.                                                    |\n| `a3799f`   | Please enable your location services.                                                           |\n| `a3793f`   | Please enable your location services.                                                           |\n| `f298cf`   | The place has disabled all links for you.                                                       |\n| `f298df`   | Your access rights for this place do not include links.                                         |\n| `f298bf`   | Your access right is invalid.                                                                   |\n| `f01337`   | Your group's access rights for this place do not include apps.                                  |\n| `34bd8f`   | Your device is not the primary one.                                                             |\n| `facced`   | Unable to decode the certificate.                                                               |\n| `bbb99f`   | Your location is not valid.                                                                     |\n| `bbb93f`   | The location of the lock is invalid.                                                            |\n| `a3995f`   | You are too far away.                                                                           |\n| `bb4faa`   | You're not close enough to the door.                                                            |\n| `bbc93f`   | In-app access is disabled by the organization. Please tap your phone against the reader.        |\n| `34ffaa`   | Your access is not allowed at this moment, please try again later.                              |\n| `f35ade`   | Your access is no longer valid.                                                                 |\n| `f398de`   | Your access is invalid.,                                                                        |\n| `f358de`   | Your access is not yet valid, please try again later.                                           |\n| `fad334`   | An error occurred permitting the the elevator stop.                                             |\n| `fad121`   | The elevator stop was not found.                                                                |\n| `fad122`   | The elevator stop was not configured.                                                           |\n| `fad123`   | The elevator stops are locked down.                                                             |\n| `fad124`   | The elevator stop was on schedule.                                                              |\n| `fad002`   | The place is currently locked down.                                                             |\n| `ff420a`   | The door has no assigned Kisi controller.                                                       |\n| `fad001`   | The door is currently locked down.                                                              |\n| `fad105`   | The door is improperly configured.                                                              |\n| `fad10e`   | The door could not be found.                                                                    |\n| `fad110`   | The door is already scheduled to be unlocked.                                                   |\n| `fad137`   | The access was denied by the zone.                                                              |\n| `fad146`   | The third party zone was overriden but it is still armed.                                       |\n| `fad10f`   | An error occurred connecting to the wireless lock.                                              |\n| `fad106`   | An error occurred finding the wireless lock.                                                    |\n| `fad107`   | The wireless lock is offline.                                                                   |\n| `fad112`   | An unlock is already in progress for the wireless lock.                                         |\n| `fac001`   | The Kisi controller is currently unavailable.                                                   |\n| `fac002`   | The Kisi controller is currently unavailable.                                                   |\n| `fac003`   | The Kisi device is currently unavailable.                                                       |\n| `fac004`   | The Kisi device is currently unavailable.                                                       |\n| `fad108`   | The Kisi controller is not yet configured.                                                      |\n| `ecc123`   | The Kisi controller encountered an unhandled error.                                             |\n| `fbc000`   | The Kisi controller firmware is being updated. This will take a few seconds. Please retry then. |\n| `aaa345`   | The zone has no assigned zone controller.                                                       |\n| `fad126`   | The zone could not be found.                                                                    |\n| `fad129`   | The alarm controller is currently unavailable.                                                  |\n| `adf234`   | An error occurred resetting the zone.                                                           |\n| `fad144`   | The third party alarm is still in violation.                                                    |\n| `abbb11`   | The integration partner experienced an error.                                                   |\n| `abcc11`   | An integration partner resource could not be found.                                             |\n| `abdd11`   | The communication with the integration partner failed.                                          |\n| `abee11`   | Authorization with the integration partner failed.                                              |\n| `abfe11`   | The integration is not acceptable                                                               |\n| `abff11`   | The integration is disabled.                                                                    |\n"
  contact:
    name: Kisi Support
    email: support@getkisi.com
servers:
- url: https://api.kisi.io
  description: Kisi Production
tags:
- name: Cameras
paths:
  /cameras:
    get:
      operationId: fetchCameras
      summary: Fetch cameras
      tags:
      - Cameras
      security:
      - Kisi-Login: []
      - OAuth2: []
      parameters:
      - name: ids
        in: query
        schema:
          type: string
        description: Filter by object IDs
      - name: place_id
        in: query
        schema:
          type: integer
        description: Filter by place ID
      - name: lock_id
        in: query
        schema:
          type: integer
        description: Filter by lock ID
      - name: sort
        in: query
        schema:
          type: string
          enum:
          - name
          - -name
        description: 'Sort the results. Prepend `-` to sort in reverse order.


          `name` - sort by camera name, alphabetically

          `-name` sort by camera name in reverse order

          '
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  oneOf:
                  - type: object
                    title: Rhombus Systems Camera
                    properties:
                      id:
                        type: integer
                        description: The ID of the camera
                      resource_type:
                        type: string
                        description: The resource type of the camera
                        const: Camera
                      name:
                        type: string
                        description: The name of the camera
                      description:
                        type:
                        - string
                        - 'null'
                        description: The description of the camera
                      created_at:
                        type: string
                        format: date-time
                        description: When the camera was created
                      updated_at:
                        type: string
                        format: date-time
                        description: When the camera was updated
                      metadata:
                        type: object
                        description: 'The metadata for the camera.

                          - Only basic types are allowed: string, null, integer, float, boolean.

                          - Keys have a limit of 50 characters.

                          - Values have a limit of 500 characters.

                          - Keys number is limited to 50.

                          '
                      enabled:
                        type: boolean
                        description: 'Whether the camera is enabled or not. Only enabled cameras takes snapshots.

                          '
                      clip_duration:
                        type: integer
                        minimum: 3
                        maximum: 60
                        description: Duration in seconds of the video clip to take.
                      number_of_snapshots:
                        type: integer
                        minimum: 1
                        maximum: 9
                        description: The number of snapshots to fetch.
                      remote_id:
                        type: string
                        description: The remote id of the camera.
                      snapshot_offset:
                        type: integer
                        minimum: -30
                        maximum: 30
                        description: Offset in seconds of the clock of the camera if it has a drift from the API.
                      supports_clips:
                        type: boolean
                        description: Whether the camera supports clips.
                      supports_images:
                        type: boolean
                        description: Whether the camera supports images.
                      supports_thumbnails:
                        type: boolean
                        description: Whether the camera supports thumbnails.
                      status:
                        type: string
                        enum:
                        - online
                        - offline
                        description: Whether the camera is online or offline.
                      status_changed_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: When the camera connectivity status last changed.
                      place_id:
                        type: integer
                        description: The place ID of the camera
                      lock_id:
                        type:
                        - integer
                        - 'null'
                        description: The lock ID of the camera
                      lock:
                        type: object
                        title: Lock
                        description: The lock of the camera
                        properties:
                          id:
                            type: integer
                            description: The ID of the lock
                          resource_type:
                            type: string
                            description: The resource type of the lock
                            const: Lock
                          name:
                            type: string
                            description: The name of the lock
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                      type:
                        type: string
                        const: rhombus_systems
                        description: The type of the camera.
                      integration_id:
                        type: integer
                        description: The integration ID of the camera
                      integration:
                        type: object
                        title: Integration
                        description: The integration of the camera
                        properties:
                          id:
                            type: integer
                            description: The ID of the integration
                          resource_type:
                            type: string
                            description: The resource type of the integration
                            const: Integration
                          name:
                            type: string
                            description: The name of the integration
                          type:
                            type: string
                            enum:
                            - rhombus_systems_camera
                            description: The type of the integration.
                        required:
                        - id
                        - resource_type
                        - name
                        - type
                        additionalProperties: false
                    required:
                    - id
                    - resource_type
                    - name
                    - description
                    - created_at
                    - updated_at
                    - metadata
                    - enabled
                    - clip_duration
                    - number_of_snapshots
                    - remote_id
                    - snapshot_offset
                    - supports_clips
                    - supports_images
                    - supports_thumbnails
                    - status
                    - status_changed_at
                    - place_id
                    - lock_id
                    - type
                    - integration_id
                    - integration
                    additionalProperties: false
                  - type: object
                    title: Generic Camera
                    properties:
                      id:
                        type: integer
                        description: The ID of the camera
                      resource_type:
                        type: string
                        description: The resource type of the camera
                        const: Camera
                      name:
                        type: string
                        description: The name of the camera
                      description:
                        type:
                        - string
                        - 'null'
                        description: The description of the camera
                      created_at:
                        type: string
                        format: date-time
                        description: When the camera was created
                      updated_at:
                        type: string
                        format: date-time
                        description: When the camera was updated
                      metadata:
                        type: object
                        description: 'The metadata for the camera.

                          - Only basic types are allowed: string, null, integer, float, boolean.

                          - Keys have a limit of 50 characters.

                          - Values have a limit of 500 characters.

                          - Keys number is limited to 50.

                          '
                      enabled:
                        type: boolean
                        description: 'Whether the camera is enabled or not. Only enabled cameras takes snapshots.

                          '
                      clip_duration:
                        type: integer
                        minimum: 3
                        maximum: 60
                        description: Duration in seconds of the video clip to take.
                      number_of_snapshots:
                        type: integer
                        minimum: 1
                        maximum: 9
                        description: The number of snapshots to fetch.
                      remote_id:
                        type: string
                        description: The remote id of the camera.
                      snapshot_offset:
                        type: integer
                        minimum: -30
                        maximum: 30
                        description: Offset in seconds of the clock of the camera if it has a drift from the API.
                      supports_clips:
                        type: boolean
                        description: Whether the camera supports clips.
                      supports_images:
                        type: boolean
                        description: Whether the camera supports images.
                      supports_thumbnails:
                        type: boolean
                        description: Whether the camera supports thumbnails.
                      status:
                        type: string
                        enum:
                        - online
                        - offline
                        description: Whether the camera is online or offline.
                      status_changed_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
                        description: When the camera connectivity status last changed.
                      place_id:
                        type: integer
                        description: The place ID of the camera
                      lock_id:
                        type:
                        - integer
                        - 'null'
                        description: The lock ID of the camera
                      lock:
                        type: object
                        title: Lock
                        description: The lock of the camera
                        properties:
                          id:
                            type: integer
                            description: The ID of the lock
                          resource_type:
                            type: string
                            description: The resource type of the lock
                            const: Lock
                          name:
                            type: string
                            description: The name of the lock
                        required:
                        - id
                        - resource_type
                        - name
                        additionalProperties: false
                      type:
                        type: string
                        const: generic
                        description: The type of the camera.
                    required:
                    - id
                    - resource_type
                    - name
                    - description
                    - created_at
                    - updated_at
                    - metadata
                    - enabled
                    - clip_duration
                    - number_of_snapshots
                    - remote_id
                    - snapshot_offset
                    - supports_clips
                    - supports_images
                    - supports_thumbnails
                    - status
                    - status_changed_at
                    - place_id
                    - lock_id
                    - type
                    additionalProperties: false
          headers:
            X-Collection-Range:
              description: 'Pagination information for offset based pagination. `start-end` represents the range

                of items requested. `total` represents the total count of items. If there is a total

                of 15 items and an offset of 10 and limit of 10 is used, the resulting header is:

                `10-19/15`.

                '
              schema:
                type: string
                pattern: ^(?<start>\d+)-(?<end>\d+)/(?<total>\d+)$
              example: 0-9/200
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createCamera
      summary: Create camera
      tags:
      - Cameras
      security:
      - Kisi-Login: []
      - OAuth2: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: Camera
              properties:
                camera:
                  type: object
                  properties:
                    clip_duration:
                      type: integer
                      minimum: 3
                      maximum: 60
                      description: Duration in seconds of the video clip to take.
                    description:
                      type:
                      - string
                      - 'null'
                      description: The description of the camera
                    metadata:
                      type: object
                      description: 'The metadata for the camera.

                        - Only basic types are allowed: string, null, integer, float, boolean.

                        - Keys have a limit of 50 characters.

                        - Values have a limit of 500 characters.

                        - Keys number is limited to 50.

                        '
                    enabled:
                      type: boolean
                      description: 'Whether the camera is enabled or not. Only enabled cameras takes snapshots.

                        '
                    lock_id:
                      type:
                      - integer
                      - 'null'
                      description: The lock ID of the camera
                    name:
                      type: string
                      description: The name of the camera
                    number_of_snapshots:
                      type: integer
                      minimum: 1
                      maximum: 9
                      description: The number of snapshots to fetch.
                    place_id:
                      type: integer
                      description: The place ID of the camera
                    remote_id:
                      type: string
                      description: The remote id of the camera.
                    snapshot_offset:
                      type: integer
                      minimum: -30
                      maximum: 30
                      description: Offset in seconds of the clock of the camera if it has a drift from the API.
                    supports_clips:
                      type: boolean
                      description: Whether the camera supports clips.
                    supports_images:
                      type: boolean
                      description: Whether the camera supports images.
                    supports_thumbnails:
                      type: boolean
                      description: Whether the camera supports thumbnails.
                  required:
                  - lock_id
                  - remote_id
              required:
              - camera
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: Generic Camera
                properties:
                  id:
                    type: integer
                    description: The ID of the camera
                  resource_type:
                    type: string
                    description: The resource type of the camera
                    const: Camera
                  name:
                    type: string
                    description: The name of the camera
                  description:
                    type:
                    - string
                    - 'null'
                    description: The description of the camera
                  created_at:
                    type: string
                    format: date-time
                    description: When the camera was created
                  updated_at:
                    type: string
                    format: date-time
                    description: When the camera was updated
                  metadata:
                    type: object
                    description: 'The metadata for the camera.

                      - Only basic types are allowed: string, null, integer, float, boolean.

                      - Keys have a limit of 50 characters.

                      - Values have a limit of 500 characters.

                      - Keys number is limited to 50.

                      '
                  enabled:
                    type: boolean
                    description: 'Whether the camera is enabled or not. Only enabled cameras takes snapshots.

                      '
                  clip_duration:
                    type: integer
                    minimum: 3
                    maximum: 60
                    description: Duration in seconds of the video clip to take.
                  number_of_snapshots:
                    type: integer
                    minimum: 1
                    maximum: 9
                    description: The number of snapshots to fetch.
                  remote_id:
                    type: string
                    description: The remote id of the camera.
                  snapshot_offset:
                    type: integer
                    minimum: -30
                    maximum: 30
                    description: Offset in seconds of the clock of the camera if it has a drift from the API.
                  supports_clips:
                    type: boolean
                    description: Whether the camera supports clips.
                  supports_images:
                    type: boolean
                    description: Whether the camera supports images.
                  supports_thumbnails:
                    type: boolean
                    description: Whether the camera supports thumbnails.
                  status:
                    type: string
                    enum:
                    - online
                    - offline
                    description: Whether the camera is online or offline.
                  status_changed_at:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: When the camera connectivity status last changed.
                  place_id:
                    type: integer
                    description: The place ID of the camera
                  lock_id:
                    type:
                    - integer
                    - 'null'
                    description: The lock ID of the camera
                  lock:
                    type: object
                    title: Lock
                    description: The lock of the camera
                    properties:
                      id:
                        type: integer
                        description: The ID of the lock
                      resource_type:
                        type: string
                        description: The resource type of the lock
                        const: Lock
      

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kisi/refs/heads/main/openapi/kisi-cameras-api-openapi.yml