API documentation

The API Documentation describes each available resource in the CLP API. Learn about parameters, errors, and how to format your requests.






IQs

The ClayIQ receives all changes and settings from your application and ensures that all locks are updated within seconds. The ClayIQ serves as the brain of a Clay System. You can use this resource to add IQs, add hardware to IQs or retrieve IQs.

Dig deeper

{
  "id": "b90df524-10c9-46a0-a484-75e41997c491",
  "mac": "00-14-22-01-23-45",
  "operator": "KPN",
  "reset_date": "2016-12-21T15:10:04.752Z",
  "online": true,
  "data_sync_state": "synced",
  "signal_strength": 1,
  "customer_reference": "Clay office",
  "time_zone": "UTC",
  "subscribed": true,
  ...
}

Locks

Clay Doors are equipped with wireless SALTO locks. You can use this resource to add locks and tags, change the name of your locks, lock and unlock doors, retrieve locks or a specific lock, or enable Office Modes (Easy Office Mode, Manual Office Mode).

Dig deeper

{
  "id": "446sav24-10c9-46a0-a484-75e41997c435",
  "iq": {
    "id": "b90df524-10c9-46a0-a484-75e419971",
    "customer_reference": "Clay office",
    ...
  },
  "left_open_alarm": false,
  "intrusion_alarm": false,
  ...
}

Tags

ClayTags replace that ring of keys. Tags represent a user’s access to a lock. Every valid tag can lock and unlock a lock. Simply assign a tag, and define when and where that tag can go. Grant designated access to visitors, employees, or even delivery services whenever it’s appropriate for them to enter.

Dig deeper

{
  "id": "ay214524-10c9-46a0-a484-75e419971",
  "source_iq_id": "b90df524-10c9-46a0-a484-75e419971",
  "tag_number": "0000000123",
  "added_date": "2016-12-21T15:10:04.893Z"
}

Access

Access is the right of an accessor to lock, or unlock a door, within a specified time. You can use this resource to define access groups and manage access to locks, as well as schedule easy office mode (EOM), manual office mode (MOM) or allow offline access.

Dig deeper

{
  "id": "ay214524-10c9-46a0-a484-75e419971",
  "remote_access": true,
  "blocked": false
}

Audit trail

Audit trail is a set of records on a particular lock or tag. You can view the logs of unlocking, including tag entries and master key entries on a particular lock, as well as logs of incidents such as; alarms like Door Left Open (DLO), tamper, Intruder Alarms and Low Battery Warnings.

Dig deeper

{
  "id": "234rpc-10c9-ihgf394-a484-235tpsv",
  "type": "Remote opening",
  "utc_date_time": "2016-12-21T15:10:04.7Z",
  "local_date_time": "2016-12-21T15:10:04.7Z",
  "lock": {
    "id": "446sav24-10c9-46a0-a484-5e4197435",
    "is_online": true
    ...
  },
  ...
}

Ready to get started?

Get in touch to learn more about how we can integrate smart locks into your business.