API Reference

Partner API Reference

Complete list of all Partner API endpoints with status indicators

Partner API Endpoints

Complete reference of all available Partner API endpoints organized by category.

Base URL

Production: https://api.chekt.comLocal Development: http://localhost:3000

Legend

  • 🔵 Ready for OE - Available for OpenEye integrations
  • 🟠 Only ADC - Available only for Alarm.com integrations
  • 🟡 Only OE - Available only for OpenEye integrations

Connection

Connect Dealer

PUT /partner/v1/dealers/connect

🟠 Only ADC

Establishes a connection between a dealer account and the CHeKT platform.

Disconnect Dealer

PUT /partner/v1/dealers/{dealerId}/disconnect

🟠 Only ADC

Disconnects a dealer account from the CHeKT platform.

Dealers

Get Dealer

GET /partner/v1/dealers/{dealerId}

🟠 Only ADC

Retrieves detailed information about a specific dealer.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier

Update Dealer

PUT /partner/v1/dealers/{dealerId}

🔵 Ready for OE

Updates dealer information and settings.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier

Sites

Create Site

POST /partner/v1/dealers/{dealerId}/sites

🔵 Ready for OE

Creates a new site under a dealer account.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier

List Sites

GET /partner/v1/dealers/{dealerId}/sites

🔵 Ready for OE

Retrieves all sites associated with a dealer.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier

Query Parameters:

  • fields (string, optional) - Comma-separated list of fields to return
  • filter (string, optional) - Filter criteria
  • sort (string, optional) - Sort field
  • dir (string, optional) - Sort direction (asc/desc)
  • limit (number, optional) - Maximum number of results
  • offset (number, optional) - Pagination offset

Get Site

GET /partner/v1/dealers/{dealerId}/sites/{siteId}

🔵 Ready for OE

Retrieves detailed information about a specific site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update Site

PUT /partner/v1/dealers/{dealerId}/sites/{siteId}

🔵 Ready for OE

Updates site information and configuration.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Delete Site

DELETE /partner/v1/dealers/{dealerId}/sites/{siteId}

🔵 Ready for OE

Removes a site from the system.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update Site Activation Status

PATCH /partner/v1/dealers/{dealerId}/sites/{siteId}/activation-status

🔵 Ready for OE

Activates or deactivates a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
PATCH /partner/v1/dealers/{dealerId}/sites/{siteId}/link

🔵 Ready for OE

Links a site to the partner platform.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
PATCH /partner/v1/dealers/{dealerId}/sites/{siteId}/unlink

🔵 Ready for OE

Unlinks a site from the partner platform.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update Site Monitoring Bindings

PUT /partner/v1/dealers/{dealerId}/sites/{siteId}/monitoring-bindings

🟡 Only OE

Updates monitoring station bindings for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Monitoring Stations

Create Monitoring Station

POST /partner/v1/dealers/{dealerId}/monitoring-stations

Creates a new monitoring station for a dealer.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier

List Monitoring Stations

GET /partner/v1/dealers/{dealerId}/monitoring-stations

Retrieves all monitoring stations for a dealer.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier

Get Monitoring Station

GET /partner/v1/dealers/{dealerId}/monitoring-stations/{monitoringStationId}

Retrieves detailed information about a specific monitoring station.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • monitoringStationId (string, required) - Unique monitoring station identifier

Update Monitoring Station

PUT /partner/v1/dealers/{dealerId}/monitoring-stations/{monitoringStationId}

Updates monitoring station information.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • monitoringStationId (string, required) - Unique monitoring station identifier

Delete Monitoring Station

DELETE /partner/v1/dealers/{dealerId}/monitoring-stations/{monitoringStationId}

Removes a monitoring station.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • monitoringStationId (string, required) - Unique monitoring station identifier

Contacts

Create Contact

POST /partner/v1/dealers/{dealerId}/sites/{siteId}/contacts

Creates a new contact for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

List Contacts

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/contacts

Retrieves all contacts for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Get Contact

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/contacts/{contactId}

Retrieves detailed information about a specific contact.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • contactId (string, required) - Unique contact identifier

Update Contact

PUT /partner/v1/dealers/{dealerId}/sites/{siteId}/contacts/{contactId}

Updates contact information.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • contactId (string, required) - Unique contact identifier

Delete Contact

DELETE /partner/v1/dealers/{dealerId}/sites/{siteId}/contacts/{contactId}

Removes a contact from a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • contactId (string, required) - Unique contact identifier

Devices

Create Device

POST /partner/v1/dealers/{dealerId}/sites/{siteId}/devices

🟠 Only ADC

Registers a new device for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

List Devices

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/devices

🔵 Ready for OE

Retrieves all devices for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update Devices

PUT /partner/v1/dealers/{dealerId}/sites/{siteId}/devices

🔵 Ready for OE

Updates multiple devices for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Get Device

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/devices/{deviceId}

🔵 Ready for OE

Retrieves detailed information about a specific device.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • deviceId (string, required) - Unique device identifier

Bulk Delete Devices

POST /partner/v1/dealers/{dealerId}/sites/{siteId}/devices/bulk-delete

🔵 Ready for OE

Deletes multiple devices in a single request.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Arming Settings

Get Arming Settings

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/arming-settings

🔵 Ready for OE

Retrieves arming settings for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update Arming Settings

PATCH /partner/v1/dealers/{dealerId}/sites/{siteId}/arming-settings

🔵 Ready for OE

Updates arming settings for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Alarm Verifications

Submit Alarm Verification Response

POST /partner/v1/dealers/{dealerId}/sites/{siteId}/alarm-verifications/{verificationId}/response

Submits a response to an alarm verification request.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • verificationId (string, required) - Unique verification request identifier

NVRs

Create NVR

POST /partner/v1/dealers/{dealerId}/sites/{siteId}/nvrs

🔵 Ready for OE

Registers a new NVR (Network Video Recorder) for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update NVR

PATCH /partner/v1/dealers/{dealerId}/sites/{siteId}/nvrs/{nvrId}

🔵 Ready for OE

Updates NVR configuration.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • nvrId (string, required) - Unique NVR identifier

Add Devices to NVR

POST /partner/v1/dealers/{dealerId}/sites/{siteId}/nvrs/{nvrId}/devices

🔵 Ready for OE

Associates devices with an NVR.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier
  • nvrId (string, required) - Unique NVR identifier

Arming Status

Get Arming Status

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/arming-status

🔵 Ready for OE

Retrieves the current arming status of a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Update Arming Status

PUT /partner/v1/dealers/{dealerId}/sites/{siteId}/arming-status

🔵 Ready for OE

Updates the arming status of a site (arm/disarm).

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Activity Logs

Get Activity Logs

GET /partner/v1/dealers/{dealerId}/sites/{siteId}/activity-logs

🟠 Only ADC

Retrieves activity logs for a site.

Path Parameters:

  • dealerId (string, required) - Unique dealer identifier
  • siteId (string, required) - Unique site identifier

Query Parameters:

  • startDate (string, optional) - Filter logs from this date (ISO 8601 format)
  • endDate (string, optional) - Filter logs until this date (ISO 8601 format)
  • limit (number, optional) - Maximum number of results
  • offset (number, optional) - Pagination offset

Next Steps

Next Steps