GEgetkisi
Cameras

Fetch cameras

Changed on
get/cameras

Request

  • Base URL
    https://api.kisi.io
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://api.kisi.io/oauth/authorize
      Token URLhttps://api.kisi.io/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idsstring

Filter by object IDs

place_idinteger

Filter by place ID

lock_idinteger

Filter by lock ID

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

status'online' | 'offline'

Filter by status

sort'name' | '-name'

Sort the results. Prepend - to sort in reverse order.

name - sort by camera name, alphabetically -name sort by camera name in reverse order

Response

OK

idinteger required

The ID of the camera

resource_type'Camera' required

The resource type of the camera

namestring required

The name of the camera

descriptionstring nullable required

The description of the camera

created_atstring date-time required

When the camera was created

updated_atstring date-time required

When the camera was updated

metadataobject required

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.
type'generic' required

The type of the camera.

enabledboolean required

Whether the camera is enabled or not. Only enabled cameras takes snapshots.

clip_durationinteger required

Duration in seconds of the video clip to take.

number_of_snapshotsinteger required

The number of snapshots to fetch.

remote_idstring required

The remote id of the camera.

snapshot_offsetinteger required

Offset in seconds of the clock of the camera if it has a drift from the API.

supports_clipsboolean required

Whether the camera supports clips.

supports_imagesboolean required

Whether the camera supports images.

supports_thumbnailsboolean required

Whether the camera supports thumbnails.

status'online' | 'offline' required

Whether the camera is online or offline.

status_changed_atstring date-time nullable required

When the camera connectivity status last changed.

place_idinteger required

The place ID of the camera

lock_idinteger nullable required

The lock ID of the camera

Changes

  • f84bf70ab13dRevision changes
    • info

      added the optional property / to the response with the status

    • info

      removed subschema #1: Rhombus Systems Camera subschema #2: Generic Camera from the response property oneOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 1e60392e64dcRevision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter status